{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Call Structure","description":"The best API documentation generator ever.","siteUrl":"https://developer-portal-starter.redoc.ly","keywords":"redocly developer portal, api portal starter, api reference docs","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"call-structure","__idx":0},"children":["Call Structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your call to the Lytx API should follow this structure:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"curl --request {httpMethod} 'https://{baseUrl}/{apiVersion}/{apiEndpoint}?{queryString}'\n--header 'Authorization: Bearer {token}'\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API call includes the following components:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Component"},"children":["Component"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Example"},"children":["Example"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["httpMethod"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET, PUT, POST, DELETE"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["method"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["baseUrl"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["https://api.lytx.com"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["url"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["apiVersion"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["v1"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["url"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["apiEndpoint"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["devices"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["url"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["queryString"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["status=active"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["request line"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["token"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["23mRzvuTKPc..."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["header"]}]}]}]}]}]},"headings":[{"value":"Call Structure","id":"call-structure","depth":1}],"frontmatter":{"seo":{"title":"Call Structure"}},"lastModified":"2024-04-10T21:37:28.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/callstructure","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}