{"items":[{"type":"link","label":"HoxtonAi API","link":"/v1","routeSlug":"/v1","content":{"contentType":"overview","meta":{"name":"HoxtonAi API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/v1/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/v1/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Proprietary","url":"https://hoxton.ai"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"HoxtonAi API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/v1"}],"sectionId":"/v1"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API requests are authenticated with a Hoxton "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", passed as a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header of every request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer hxt_live_.\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer hxt_live_.\n"},"children":[]}]}]}],"sectionId":"/v1/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication/creating-an-api-key"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating an API key"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and manage API keys for your organisation from your dashboard settings"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"at "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://nexus.hoxton.ai/my-org/api-keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://nexus.hoxton.ai/my-org/api-keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"programmatically via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/api-keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints documented below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The secret is shown "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"once"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", at creation time — store it securely, as it"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot be retrieved afterwards. Each key belongs to a single organisation and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is scoped to that organisation's data."},"children":[]}]}]}]}],"sectionId":"/v1/section/authentication/creating-an-api-key"}],"sectionId":"/v1/section/authentication/creating-an-api-key"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication/using-an-api-key"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using an API key"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl https://nexus.hoxton.ai/api/v1/organisations \\\n -H 'Authorization: Bearer hxt_live_.'\n","language":"shell"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl https://nexus.hoxton.ai/api/v1/organisations \\\n -H 'Authorization: Bearer hxt_live_.'\n"},"children":[]}]}]}],"sectionId":"/v1/section/authentication/using-an-api-key"}],"sectionId":"/v1/section/authentication/using-an-api-key"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication/expiry-and-revocation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expiry and revocation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key may be created with an optional expiry. Keys can be revoked at any time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the dashboard or via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /api-keys/{apiKeyId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a revoked or expired"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"key is rejected immediately on subsequent requests."},"children":[]}]}]}]}],"sectionId":"/v1/section/authentication/expiry-and-revocation"}],"sectionId":"/v1/section/authentication/expiry-and-revocation"}]}]}},{"type":"group","label":"Authentication","link":"/v1/section/authentication","routeSlug":"/v1/section/authentication","items":[{"type":"link","label":"Creating an API key","link":"/v1/section/authentication/creating-an-api-key","routeSlug":"/v1/section/authentication/creating-an-api-key","content":null},{"type":"link","label":"Using an API key","link":"/v1/section/authentication/using-an-api-key","routeSlug":"/v1/section/authentication/using-an-api-key","content":null},{"type":"link","label":"Expiry and revocation","link":"/v1/section/authentication/expiry-and-revocation","routeSlug":"/v1/section/authentication/expiry-and-revocation","content":null}],"content":null},{"type":"separator","label":"ANALYTICS","content":null},{"type":"group","label":"Reports","link":"/v1/report","routeSlug":"/v1/report","items":[{"label":"Create aggregated api metrics report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/report/createaggregatedapirequestmetricsreport","routeSlug":"/v1/report/createaggregatedapirequestmetricsreport","metadata":{"seo":{"title":"Create aggregated api metrics report","description":"Create a report of aggregated api request metrics for a given time range and list of organisations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateAggregatedAPIRequestMetricsReport","name":"Create aggregated api metrics report","isWebhook":false,"pointer":"/paths/~1aggregated-api-request-metrics-reports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create aggregated api metrics report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a report of aggregated api request metrics for a given time range and list of organisations."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AggregatedApiRequestMetricsReport"}},"schemaId":"components/schemas/AggregatedApiRequestMetricsReport","pointer":"/paths/~1aggregated-api-request-metrics-reports/post/requestBody","description":"request aggregated api request metrics data for a set of orgs and a given time range."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/aggregated-api-request-metrics-reports","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AggregatedApiRequestMetricsReport"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/aggregated-api-request-metrics-reports","href":"report/createaggregatedapirequestmetricsreport","openApiOperationId":"CreateAggregatedAPIRequestMetricsReport","summary":"Create aggregated api metrics report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/AggregatedApiRequestMetricsReport","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AggregatedApiRequestMetricsReport"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42"}},"schemaId":"schema_42"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1aggregated-api-request-metrics-reports/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_42","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report/createaggregatedapirequestmetricsreport"}],"panels":[]}]},"httpPath":"/aggregated-api-request-metrics-reports"},{"label":"Create aggregated video metrics report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/report/createaggregatedvideometricsreport","routeSlug":"/v1/report/createaggregatedvideometricsreport","metadata":{"seo":{"title":"Create aggregated video metrics report","description":"Create a report of aggregated camera metrics for a given time range and list of cameras."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateAggregatedVideoMetricsReport","name":"Create aggregated video metrics report","isWebhook":false,"pointer":"/paths/~1aggregated-video-metrics-reports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create aggregated video metrics report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a report of aggregated camera metrics for a given time range and list of cameras."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AggregatedVideoMetricsReport"}},"schemaId":"components/schemas/AggregatedVideoMetricsReport","pointer":"/paths/~1aggregated-video-metrics-reports/post/requestBody","description":"request aggregated video metrics data for a set of cameras and a given time range."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/aggregated-video-metrics-reports","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AggregatedVideoMetricsReport"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/aggregated-video-metrics-reports","href":"report/createaggregatedvideometricsreport","openApiOperationId":"CreateAggregatedVideoMetricsReport","summary":"Create aggregated video metrics report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/AggregatedVideoMetricsReport","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AggregatedVideoMetricsReport"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1aggregated-video-metrics-reports/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_43"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report/createaggregatedvideometricsreport"}],"panels":[]}]},"httpPath":"/aggregated-video-metrics-reports"},{"label":"Create live occupancy report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/report/createliveoccupancyreport","routeSlug":"/v1/report/createliveoccupancyreport","metadata":{"seo":{"title":"Create live occupancy report","description":"Create a report of live occupancies for a list of occupancy monitors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateLiveOccupancyReport","name":"Create live occupancy report","isWebhook":false,"pointer":"/paths/~1live-occupancy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create live occupancy report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a report of live occupancies for a list of occupancy monitors."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LiveOccupancyReport"}},"schemaId":"components/schemas/LiveOccupancyReport","pointer":"/paths/~1live-occupancy/post/requestBody","description":"request live occupancies for a list of occupancy monitors."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/live-occupancy","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LiveOccupancyReport"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/live-occupancy","href":"report/createliveoccupancyreport","openApiOperationId":"CreateLiveOccupancyReport","summary":"Create live occupancy report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/LiveOccupancyReport","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LiveOccupancyReport"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}},"schemaId":"schema_44"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1live-occupancy/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_44","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report/createliveoccupancyreport"}],"panels":[]}]},"httpPath":"/live-occupancy"},{"label":"Create occupancy report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/report/createoccupancyreport","routeSlug":"/v1/report/createoccupancyreport","metadata":{"seo":{"title":"Create occupancy report","description":"Create a report of occupancy counts for a given time range and set of monitors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateOccupancyReport","name":"Create occupancy report","isWebhook":false,"pointer":"/paths/~1occupancy-reports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create occupancy report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a report of occupancy counts for a given time range and set of monitors."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OccupancyReport"}},"schemaId":"components/schemas/OccupancyReport","pointer":"/paths/~1occupancy-reports/post/requestBody","description":"request occupancy data for a set of monitors and a given time range."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/occupancy-reports","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OccupancyReport"}},"responseCodes":["200","400","401","403","413","422","500"],"pointer":"/occupancy-reports","href":"report/createoccupancyreport","openApiOperationId":"CreateOccupancyReport","summary":"Create occupancy report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/OccupancyReport","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OccupancyReport"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}},"schemaId":"schema_45"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"413","description":"Payload too large.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1occupancy-reports/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_45","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"413","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report/createoccupancyreport"}],"panels":[]}]},"httpPath":"/occupancy-reports"},{"label":"Create peel off report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/report/createpeeloffreport","routeSlug":"/v1/report/createpeeloffreport","metadata":{"seo":{"title":"Create peel off report","description":"Create a peel off report for a given time range and set of monitors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreatePeelOffReport","name":"Create peel off report","isWebhook":false,"pointer":"/paths/~1peel-off-reports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create peel off report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a peel off report for a given time range and set of monitors."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PeelOffReport"}},"schemaId":"components/schemas/PeelOffReport","pointer":"/paths/~1peel-off-reports/post/requestBody","description":"request peel off data for a set of monitors and a given time range."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/peel-off-reports","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PeelOffReport"}},"responseCodes":["200","400","401","403","413","422","500"],"pointer":"/peel-off-reports","href":"report/createpeeloffreport","openApiOperationId":"CreatePeelOffReport","summary":"Create peel off report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/PeelOffReport","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PeelOffReport"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_46"}},"schemaId":"schema_46"},{"code":"400","description":"bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"413","description":"Payload too large","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1peel-off-reports/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_46","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_46"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"413","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report/createpeeloffreport"}],"panels":[]}]},"httpPath":"/peel-off-reports"},{"label":"Create people count report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/report/createpeoplecountreport","routeSlug":"/v1/report/createpeoplecountreport","metadata":{"seo":{"title":"Create people count report","description":"Create a report of people counts for a given time range and set of monitors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreatePeopleCountReport","name":"Create people count report","isWebhook":false,"pointer":"/paths/~1people-count-reports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create people count report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a report of people counts for a given time range and set of monitors."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PeopleCountReport"}},"schemaId":"components/schemas/PeopleCountReport","pointer":"/paths/~1people-count-reports/post/requestBody","description":"request people count data for a set of monitors and a given time range."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/people-count-reports","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PeopleCountReport"}},"responseCodes":["200","400","401","403","413","422","500"],"pointer":"/people-count-reports","href":"report/createpeoplecountreport","openApiOperationId":"CreatePeopleCountReport","summary":"Create people count report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/PeopleCountReport","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PeopleCountReport"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47"}},"schemaId":"schema_47"},{"code":"400","description":"bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"413","description":"Payload too large","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1people-count-reports/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_47","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"413","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report/createpeoplecountreport"}],"panels":[]}]},"httpPath":"/people-count-reports"}],"content":{"contentType":"group","meta":{"name":"report"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reports","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an Organisation's monitor reports."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/aggregated-api-request-metrics-reports","summary":"Create aggregated api metrics report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/report/createaggregatedapirequestmetricsreport","deprecated":false},{"title":"/aggregated-video-metrics-reports","summary":"Create aggregated video metrics report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/report/createaggregatedvideometricsreport","deprecated":false},{"title":"/live-occupancy","summary":"Create live occupancy report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/report/createliveoccupancyreport","deprecated":false},{"title":"/occupancy-reports","summary":"Create occupancy report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/report/createoccupancyreport","deprecated":false},{"title":"/peel-off-reports","summary":"Create peel off report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/report/createpeeloffreport","deprecated":false},{"title":"/people-count-reports","summary":"Create people count report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/report/createpeoplecountreport","deprecated":false}]}]}]}]}},{"type":"group","label":"Dwell Times","link":"/v1/dwelltimereport","routeSlug":"/v1/dwelltimereport","items":[{"label":"List Dwell Time Reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/dwelltimereport/listdwelltimereports","routeSlug":"/v1/dwelltimereport/listdwelltimereports","metadata":{"seo":{"title":"List Dwell Time Reports","description":"List of all dwell time reports for the given organisation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListDwellTimeReports","name":"List Dwell Time Reports","isWebhook":false,"pointer":"/paths/~1dwell-time-reports/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Dwell Time Reports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List of all dwell time reports for the given organisation"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"organisationId","in":"query","schemaId":"schema_48","description":"The ID of the associated organisation."},{"name":"status","in":"query","schemaId":"schema_49","description":"report status."}],"pointer":"/paths/~1dwell-time-reports/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/dwell-time-reports","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"status","in":"query","schemaId":"schema_49"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","500","501"],"pointer":"/dwell-time-reports","href":"dwelltimereport/listdwelltimereports","openApiOperationId":"ListDwellTimeReports","summary":"List Dwell Time Reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1dwell-time-reports/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dwelltimereport/listdwelltimereports"}],"panels":[]}]},"httpPath":"/dwell-time-reports"},{"label":"Create dwell time report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/dwelltimereport/createdwelltimereport","routeSlug":"/v1/dwelltimereport/createdwelltimereport","metadata":{"seo":{"title":"Create dwell time report","description":"Create a report of dwell time for a given time range and given organisation"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateDwellTimeReport","name":"Create dwell time report","isWebhook":false,"pointer":"/paths/~1dwell-time-reports/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create dwell time report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a report of dwell time for a given time range and given organisation"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DwellTimeReportRequest"}},"schemaId":"components/schemas/DwellTimeReportRequest","pointer":"/paths/~1dwell-time-reports/post/requestBody","description":"request dwell time data for an organisation and a given time range."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/dwell-time-reports","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DwellTimeReportRequest"}},"responseCodes":["200","400","401","403","413","422","500","501"],"pointer":"/dwell-time-reports","href":"dwelltimereport/createdwelltimereport","openApiOperationId":"CreateDwellTimeReport","summary":"Create dwell time report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/DwellTimeReportRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DwellTimeReportRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DwellTimeRequestResponse"}},"schemaId":"components/schemas/DwellTimeRequestResponse"},{"code":"400","description":"bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"not allowed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"413","description":"Payload too large","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"unprocessable entity","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1dwell-time-reports/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DwellTimeRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DwellTimeRequestResponse"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"413","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dwelltimereport/createdwelltimereport"}],"panels":[]}]},"httpPath":"/dwell-time-reports"},{"label":"Get Dwell Time Report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/dwelltimereport/getdwelltimereport","routeSlug":"/v1/dwelltimereport/getdwelltimereport","metadata":{"seo":{"title":"Get Dwell Time Report","description":"Get a dwell time report identified by the provided report ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetDwellTimeReport","name":"Get Dwell Time Report","isWebhook":false,"pointer":"/paths/~1dwell-time-reports~1{dwellTimeReportId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Dwell Time Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a dwell time report identified by the provided report ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dwellTimeReportId","in":"path","schemaId":"schema_48","description":"The full report ID of a report to be fetched.","required":true}],"pointer":"/paths/~1dwell-time-reports~1{dwellTimeReportId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/dwell-time-reports/{dwellTimeReportId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"dwellTimeReportId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","500","501"],"pointer":"/dwell-time-reports/{dwellTimeReportId}","href":"dwelltimereport/getdwelltimereport","openApiOperationId":"GetDwellTimeReport","summary":"Get Dwell Time Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DwellTimeRequestResponse"}},"schemaId":"components/schemas/DwellTimeRequestResponse"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1dwell-time-reports~1{dwellTimeReportId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DwellTimeRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DwellTimeRequestResponse"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dwelltimereport/getdwelltimereport"}],"panels":[]}]},"httpPath":"/dwell-time-reports/{dwellTimeReportId}"}],"content":{"contentType":"group","meta":{"name":"dwellTimeReport"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Dwell Times","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an Organisation's Dwell Time reports."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/dwell-time-reports","summary":"List Dwell Time Reports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dwelltimereport/listdwelltimereports","deprecated":false},{"title":"/dwell-time-reports","summary":"Create dwell time report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dwelltimereport/createdwelltimereport","deprecated":false},{"title":"/dwell-time-reports/{dwellTimeReportId}","summary":"Get Dwell Time Report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dwelltimereport/getdwelltimereport","deprecated":false}]}]}]}]}},{"type":"separator","label":"ADMIN","content":null},{"type":"group","label":"Organisations","link":"/v1/organisation","routeSlug":"/v1/organisation","items":[{"label":"List organisations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/organisation/listorganisations","routeSlug":"/v1/organisation/listorganisations","metadata":{"seo":{"title":"List organisations","description":"List organisations in the portfolio."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListOrganisations","name":"List organisations","isWebhook":false,"pointer":"/paths/~1organisations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List organisations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List organisations in the portfolio."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"userId","in":"query","schemaId":"schema_48","description":"The ID of a user."}],"pointer":"/paths/~1organisations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"userId","in":"query","schemaId":"schema_48"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500"],"pointer":"/organisations","href":"organisation/listorganisations","openApiOperationId":"ListOrganisations","summary":"List organisations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1organisations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organisation/listorganisations"}],"panels":[]}]},"httpPath":"/organisations"},{"label":"Get organisation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/organisation/getorganisation","routeSlug":"/v1/organisation/getorganisation","metadata":{"seo":{"title":"Get organisation","description":"Get all attributes of an organisation model given an organisation ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetOrganisation","name":"Get organisation","isWebhook":false,"pointer":"/paths/~1organisations~1{organisationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get organisation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all attributes of an organisation model given an organisation ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"organisationId","in":"path","schemaId":"schema_48","description":"The ID of the organisation to be returned.","required":true}],"pointer":"/paths/~1organisations~1{organisationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/organisations/{organisationId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"organisationId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/organisations/{organisationId}","href":"organisation/getorganisation","openApiOperationId":"GetOrganisation","summary":"Get organisation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organisation"}},"schemaId":"components/schemas/Organisation"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1organisations~1{organisationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Organisation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Organisation"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organisation/getorganisation"}],"panels":[]}]},"httpPath":"/organisations/{organisationId}"}],"content":{"contentType":"group","meta":{"name":"organisation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organisations","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage Organisations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/organisations","summary":"List organisations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organisation/listorganisations","deprecated":false},{"title":"/organisations/{organisationId}","summary":"Get organisation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organisation/getorganisation","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/v1/user","routeSlug":"/v1/user","items":[{"label":"List users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/user/listusers","routeSlug":"/v1/user/listusers","metadata":{"seo":{"title":"List users","description":"Fetch the list of users associated with an organisation or site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListUsers","name":"List users","isWebhook":false,"pointer":"/paths/~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fetch the list of users associated with an organisation or site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"organisationId","in":"query","schemaId":"schema_48","description":"The ID of an organisation."},{"name":"siteId","in":"query","schemaId":"schema_48","description":"The ID of a site."},{"name":"includeSupport","in":"query","schemaId":"schema_52","description":"When true, include support users in the response."}],"pointer":"/paths/~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"siteId","in":"query","schemaId":"schema_48"},{"name":"includeSupport","in":"query","schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","500"],"pointer":"/users","href":"user/listusers","openApiOperationId":"ListUsers","summary":"List users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53"}},"schemaId":"schema_53"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_53","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/listusers"}],"panels":[]}]},"httpPath":"/users"},{"label":"Create/Update user","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/user/putuser","routeSlug":"/v1/user/putuser","metadata":{"seo":{"title":"Create/Update user","description":"Create/Update an user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutUser","name":"Create/Update user","isWebhook":false,"pointer":"/paths/~1users/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create/Update user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create/Update an user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User","pointer":"/paths/~1users/put/requestBody","description":"A user to update."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/users","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/User"}},"responseCodes":["201","204","400","401","403","404","422","500"],"pointer":"/users","href":"user/putuser","openApiOperationId":"PutUser","summary":"Create/Update user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/User"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1users/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/putuser"}],"panels":[]}]},"httpPath":"/users"},{"label":"Get my profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/user/getme","routeSlug":"/v1/user/getme","metadata":{"seo":{"title":"Get my profile","description":"Returns the profile data of the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetMe","name":"Get my profile","isWebhook":false,"pointer":"/paths/~1users~1me/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get my profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the profile data of the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/me","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","403","422","500"],"pointer":"/users/me","href":"user/getme","openApiOperationId":"GetMe","summary":"Get my profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1users~1me/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/getme"}],"panels":[]}]},"httpPath":"/users/me"},{"label":"Delete user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/user/deleteuser","routeSlug":"/v1/user/deleteuser","metadata":{"seo":{"title":"Delete user","description":"Remove an user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteUser","name":"Delete user","isWebhook":false,"pointer":"/paths/~1users~1{userId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove an user."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_54","description":"The ID of the user to be deleted.","required":true}],"pointer":"/paths/~1users~1{userId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/users/{userId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_54"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","500"],"pointer":"/users/{userId}","href":"user/deleteuser","openApiOperationId":"DeleteUser","summary":"Delete user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1users~1{userId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/deleteuser"}],"panels":[]}]},"httpPath":"/users/{userId}"},{"label":"Get user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/user/getuser","routeSlug":"/v1/user/getuser","metadata":{"seo":{"title":"Get user","description":"Get details of the user given by the ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetUser","name":"Get user","isWebhook":false,"pointer":"/paths/~1users~1{userId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get details of the user given by the ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"userId","in":"path","schemaId":"schema_54","description":"The ID of the user to be returned.","required":true}],"pointer":"/paths/~1users~1{userId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{userId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"userId","in":"path","required":true,"schemaId":"schema_54"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/users/{userId}","href":"user/getuser","openApiOperationId":"GetUser","summary":"Get user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1users~1{userId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/getuser"}],"panels":[]}]},"httpPath":"/users/{userId}"}],"content":{"contentType":"group","meta":{"name":"user"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an Organisation's users."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users","summary":"List users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/listusers","deprecated":false},{"title":"/users","summary":"Create/Update user","prefix":{"name":"put","color":"put"},"badges":[],"link":"/user/putuser","deprecated":false},{"title":"/users/me","summary":"Get my profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/getme","deprecated":false},{"title":"/users/{userId}","summary":"Delete user","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user/deleteuser","deprecated":false},{"title":"/users/{userId}","summary":"Get user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/getuser","deprecated":false}]}]}]}]}},{"type":"group","label":"API Keys","link":"/v1/apikey","routeSlug":"/v1/apikey","items":[{"label":"List API keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/apikey/listapikeys","routeSlug":"/v1/apikey/listapikeys","metadata":{"seo":{"title":"List API keys","description":"List API keys belonging to the caller's organisation. Secrets are never returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListApiKeys","name":"List API keys","isWebhook":false,"pointer":"/paths/~1api-keys/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List API keys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List API keys belonging to the caller's organisation. Secrets are never returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api-keys","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","500"],"pointer":"/api-keys","href":"apikey/listapikeys","openApiOperationId":"ListApiKeys","summary":"List API keys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_55"}},"schemaId":"schema_55"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1api-keys/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_55","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_55"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apikey/listapikeys"}],"panels":[]}]},"httpPath":"/api-keys"},{"label":"Create API key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/apikey/createapikey","routeSlug":"/v1/apikey/createapikey","metadata":{"seo":{"title":"Create API key","description":"Create a new API key and return it. The token field is shown only once and cannot be retrieved again — the caller must store it securely."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateApiKey","name":"Create API key","isWebhook":false,"pointer":"/paths/~1api-keys/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a new API key and return it. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field is shown only once and cannot be retrieved again — the caller must store it securely."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_56"}},"schemaId":"schema_56","pointer":"/paths/~1api-keys/post/requestBody","description":"The API key to create."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api-keys","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_56"}},"responseCodes":["201","400","401","403","412","500"],"pointer":"/api-keys","href":"apikey/createapikey","openApiOperationId":"CreateApiKey","summary":"Create API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"schema_56","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_56"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyCreated"}},"schemaId":"components/schemas/ApiKeyCreated"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"412","description":"Precondition failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1api-keys/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ApiKeyCreated","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyCreated"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"412","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apikey/createapikey"}],"panels":[]}]},"httpPath":"/api-keys"},{"label":"Revoke API key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/apikey/revokeapikey","routeSlug":"/v1/apikey/revokeapikey","metadata":{"seo":{"title":"Revoke API key","description":"Revoke an API key. The key is immediately rejected on subsequent requests."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RevokeApiKey","name":"Revoke API key","isWebhook":false,"pointer":"/paths/~1api-keys~1{apiKeyId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revoke an API key. The key is immediately rejected on subsequent requests."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"apiKeyId","in":"path","schemaId":"schema_48","description":"The ID of the API key to revoke.","required":true}],"pointer":"/paths/~1api-keys~1{apiKeyId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api-keys/{apiKeyId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"apiKeyId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","500"],"pointer":"/api-keys/{apiKeyId}","href":"apikey/revokeapikey","openApiOperationId":"RevokeApiKey","summary":"Revoke API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1api-keys~1{apiKeyId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apikey/revokeapikey"}],"panels":[]}]},"httpPath":"/api-keys/{apiKeyId}"},{"label":"Get API key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/apikey/getapikey","routeSlug":"/v1/apikey/getapikey","metadata":{"seo":{"title":"Get API key","description":"Get API key metadata. Secrets are never returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetApiKey","name":"Get API key","isWebhook":false,"pointer":"/paths/~1api-keys~1{apiKeyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get API key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get API key metadata. Secrets are never returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"apiKeyId","in":"path","schemaId":"schema_48","description":"The ID of the API key.","required":true}],"pointer":"/paths/~1api-keys~1{apiKeyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api-keys/{apiKeyId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"apiKeyId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/api-keys/{apiKeyId}","href":"apikey/getapikey","openApiOperationId":"GetApiKey","summary":"Get API key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyLink"}},"schemaId":"components/schemas/ApiKeyLink"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1api-keys~1{apiKeyId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApiKeyLink","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiKeyLink"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apikey/getapikey"}],"panels":[]}]},"httpPath":"/api-keys/{apiKeyId}"}],"content":{"contentType":"group","meta":{"name":"apiKey"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API Keys","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage API keys."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api-keys","summary":"List API keys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/apikey/listapikeys","deprecated":false},{"title":"/api-keys","summary":"Create API key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/apikey/createapikey","deprecated":false},{"title":"/api-keys/{apiKeyId}","summary":"Revoke API key","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/apikey/revokeapikey","deprecated":false},{"title":"/api-keys/{apiKeyId}","summary":"Get API key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/apikey/getapikey","deprecated":false}]}]}]}]}},{"type":"separator","label":"SITE","content":null},{"type":"group","label":"Sites","link":"/v1/site","routeSlug":"/v1/site","items":[{"label":"List sites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/site/listsites","routeSlug":"/v1/site/listsites","metadata":{"seo":{"title":"List sites","description":"List all the sites in the portfolio along with the organisations that own them."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListSites","name":"List sites","isWebhook":false,"pointer":"/paths/~1sites/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List sites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all the sites in the portfolio along with the organisations that own them."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"organisationId","in":"query","schemaId":"schema_48","description":"The ID of an organisation."},{"name":"userId","in":"query","schemaId":"schema_54","description":"The ID of a user."},{"name":"state","in":"query","schemaId":"schema_57","description":"Site state."}],"pointer":"/paths/~1sites/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sites","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"userId","in":"query","schemaId":"schema_54"},{"name":"state","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","500"],"pointer":"/sites","href":"site/listsites","openApiOperationId":"ListSites","summary":"List sites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58"}},"schemaId":"schema_58"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1sites/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_58","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site/listsites"}],"panels":[]}]},"httpPath":"/sites"},{"label":"Create/Update site","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/site/putsite","routeSlug":"/v1/site/putsite","metadata":{"seo":{"title":"Create/Update site","description":"Update site information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutSite","name":"Create/Update site","isWebhook":false,"pointer":"/paths/~1sites/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create/Update site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update site information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Site"}},"schemaId":"components/schemas/Site","pointer":"/paths/~1sites/put/requestBody","description":"Update site information."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/sites","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Site"}},"responseCodes":["201","204","400","401","403","410","422","500"],"pointer":"/sites","href":"site/putsite","openApiOperationId":"PutSite","summary":"Create/Update site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/Site","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Site"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Site"}},"schemaId":"components/schemas/Site"},{"code":"204","description":"Update was successful."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1sites/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Site","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Site"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site/putsite"}],"panels":[]}]},"httpPath":"/sites"},{"label":"Delete site","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/site/deletesite","routeSlug":"/v1/site/deletesite","metadata":{"seo":{"title":"Delete site","description":"Set the state of a site to decommissioned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteSite","name":"Delete site","isWebhook":false,"pointer":"/paths/~1sites~1{siteId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set the state of a site to decommissioned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_48","description":"The ID of the site that will be decommissioned.","required":true}],"pointer":"/paths/~1sites~1{siteId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/sites/{siteId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","410","422","500"],"pointer":"/sites/{siteId}","href":"site/deletesite","openApiOperationId":"DeleteSite","summary":"Delete site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1sites~1{siteId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site/deletesite"}],"panels":[]}]},"httpPath":"/sites/{siteId}"},{"label":"Get site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/site/getsite","routeSlug":"/v1/site/getsite","metadata":{"seo":{"title":"Get site","description":"Get all attributes of a site model given a site ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetSite","name":"Get site","isWebhook":false,"pointer":"/paths/~1sites~1{siteId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all attributes of a site model given a site ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"siteId","in":"path","schemaId":"schema_48","description":"The ID of the site to be returned.","required":true}],"pointer":"/paths/~1sites~1{siteId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/sites/{siteId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"siteId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/sites/{siteId}","href":"site/getsite","openApiOperationId":"GetSite","summary":"Get site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Site"}},"schemaId":"components/schemas/Site"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1sites~1{siteId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Site","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Site"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site/getsite"}],"panels":[]}]},"httpPath":"/sites/{siteId}"}],"content":{"contentType":"group","meta":{"name":"site"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sites","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an organisation's sites."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/sites","summary":"List sites","prefix":{"name":"get","color":"get"},"badges":[],"link":"/site/listsites","deprecated":false},{"title":"/sites","summary":"Create/Update site","prefix":{"name":"put","color":"put"},"badges":[],"link":"/site/putsite","deprecated":false},{"title":"/sites/{siteId}","summary":"Delete site","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/site/deletesite","deprecated":false},{"title":"/sites/{siteId}","summary":"Get site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/site/getsite","deprecated":false}]}]}]}]}},{"type":"separator","label":"CAMERA","content":null},{"type":"group","label":"Cameras","link":"/v1/camera","routeSlug":"/v1/camera","items":[{"label":"List cameras","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/camera/listcameras","routeSlug":"/v1/camera/listcameras","metadata":{"seo":{"title":"List cameras","description":"List all claimed cameras in the fleet along with the organisations that own them."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListCameras","name":"List cameras","isWebhook":false,"pointer":"/paths/~1cameras/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List cameras","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all claimed cameras in the fleet along with the organisations that own them."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeMetrics","in":"query","schemaId":"schema_59","description":"Choose whether camera metrics should be included in the response or not."},{"name":"siteId","in":"query","schemaId":"schema_48","description":"The ID of the site whose list of associated cameras will be returned."},{"name":"userId","in":"query","schemaId":"schema_48","description":"The ID of a user on whose visibility of the cameras to filter on."},{"name":"state","in":"query","schemaId":"schema_60","description":"The camera states to filter on."}],"pointer":"/paths/~1cameras/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cameras","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"includeMetrics","in":"query","schemaId":"schema_59"},{"name":"siteId","in":"query","schemaId":"schema_48"},{"name":"userId","in":"query","schemaId":"schema_48"},{"name":"state","in":"query","required":false,"schemaId":"schema_60","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500"],"pointer":"/cameras","href":"camera/listcameras","openApiOperationId":"ListCameras","summary":"List cameras"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}},"schemaId":"schema_61"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1cameras/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_61","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/camera/listcameras"}],"panels":[]}]},"httpPath":"/cameras"},{"label":"Link camera to organisation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/camera/createcamera","routeSlug":"/v1/camera/createcamera","metadata":{"seo":{"title":"Link camera to organisation","description":"Link a camera to an organisation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateCamera","name":"Link camera to organisation","isWebhook":false,"pointer":"/paths/~1cameras/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Link camera to organisation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Link a camera to an organisation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62","pointer":"/paths/~1cameras/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cameras","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_62"}},"responseCodes":["201","400","401","403","404","409","500"],"pointer":"/cameras","href":"camera/createcamera","openApiOperationId":"CreateCamera","summary":"Link camera to organisation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_62"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Camera"}},"schemaId":"components/schemas/Camera"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"409","description":"This camera has already been claimed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1cameras/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Camera","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Camera"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/camera/createcamera"}],"panels":[]}]},"httpPath":"/cameras"},{"label":"Delete camera","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/camera/deletecamera","routeSlug":"/v1/camera/deletecamera","metadata":{"seo":{"title":"Delete camera","description":"Decommission a camera that is in state running or paused."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteCamera","name":"Delete camera","isWebhook":false,"pointer":"/paths/~1cameras~1{cameraId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete camera","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Decommission a camera that is in state running or paused."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cameraId","in":"path","schemaId":"schema_48","description":"the camera ID of the camera.","required":true}],"pointer":"/paths/~1cameras~1{cameraId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/cameras/{cameraId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"cameraId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","422","500"],"pointer":"/cameras/{cameraId}","href":"camera/deletecamera","openApiOperationId":"DeleteCamera","summary":"Delete camera"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1cameras~1{cameraId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/camera/deletecamera"}],"panels":[]}]},"httpPath":"/cameras/{cameraId}"},{"label":"Get camera","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/camera/getcamera","routeSlug":"/v1/camera/getcamera","metadata":{"seo":{"title":"Get camera","description":"Get a camera identified by the provided camera ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCamera","name":"Get camera","isWebhook":false,"pointer":"/paths/~1cameras~1{cameraId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get camera","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a camera identified by the provided camera ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cameraId","in":"path","schemaId":"schema_48","description":"The full camera ID of a camera to be fetched.","required":true}],"pointer":"/paths/~1cameras~1{cameraId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"includeMetrics","in":"query","schemaId":"schema_59","description":"Choose whether camera metrics should be included in the response or not."}],"pointer":"/paths/~1cameras~1{cameraId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cameras/{cameraId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"cameraId","in":"path","required":true,"schemaId":"schema_48"}],"query":[{"name":"includeMetrics","in":"query","schemaId":"schema_59"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","500"],"pointer":"/cameras/{cameraId}","href":"camera/getcamera","openApiOperationId":"GetCamera","summary":"Get camera"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Camera"}},"schemaId":"components/schemas/Camera"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1cameras~1{cameraId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Camera","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Camera"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/camera/getcamera"}],"panels":[]}]},"httpPath":"/cameras/{cameraId}"},{"label":"Patch camera","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/camera/patchcamera","routeSlug":"/v1/camera/patchcamera","metadata":{"seo":{"title":"Patch camera","description":"Update camera name and/or direction aliases of the camera identified by the provided camera ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PatchCamera","name":"Patch camera","isWebhook":false,"pointer":"/paths/~1cameras~1{cameraId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patch camera","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update camera name and/or direction aliases of the camera identified by the provided camera ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cameraId","in":"path","schemaId":"schema_48","description":"The full camera ID of a camera to be patched.","required":true}],"pointer":"/paths/~1cameras~1{cameraId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchCameraRequest"}},"schemaId":"components/schemas/PatchCameraRequest","pointer":"/paths/~1cameras~1{cameraId}/patch/requestBody","description":"Update a camera's name and/or direction alias/es."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/cameras/{cameraId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"cameraId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PatchCameraRequest"}},"responseCodes":["200","400","401","403","404","422","500"],"pointer":"/cameras/{cameraId}","href":"camera/patchcamera","openApiOperationId":"PatchCamera","summary":"Patch camera"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/PatchCameraRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PatchCameraRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Camera"}},"schemaId":"components/schemas/Camera"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1cameras~1{cameraId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Camera","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Camera"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/camera/patchcamera"}],"panels":[]}]},"httpPath":"/cameras/{cameraId}"},{"label":"Move camera","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/camera/movecamera","routeSlug":"/v1/camera/movecamera","metadata":{"seo":{"title":"Move camera","description":"Move camera to new site"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MoveCamera","name":"Move camera","isWebhook":false,"pointer":"/paths/~1cameras~1{cameraId}~1move/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Move camera","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Move camera to new site"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cameraId","in":"path","schemaId":"schema_54","required":true}],"pointer":"/paths/~1cameras~1{cameraId}~1move/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_63"}},"schemaId":"schema_63","pointer":"/paths/~1cameras~1{cameraId}~1move/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cameras/{cameraId}/move","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"cameraId","in":"path","required":true,"schemaId":"schema_54"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_63"}},"responseCodes":["201","400","401","403","404","422","500"],"pointer":"/cameras/{cameraId}/move","href":"camera/movecamera","openApiOperationId":"MoveCamera","summary":"Move camera"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"schema_63","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_63"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Camera"}},"schemaId":"components/schemas/Camera"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable Content.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1cameras~1{cameraId}~1move/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Camera","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Camera"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/camera/movecamera"}],"panels":[]}]},"httpPath":"/cameras/{cameraId}/move"},{"label":"Get camera opening hour","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/camera/getcameraopeninghour","routeSlug":"/v1/camera/getcameraopeninghour","metadata":{"seo":{"title":"Get camera opening hour","description":"Get all attributes of a camera model given a camera ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetCameraOpeningHour","name":"Get camera opening hour","isWebhook":false,"pointer":"/paths/~1cameras~1{cameraId}~1opening-hours/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get camera opening hour","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all attributes of a camera model given a camera ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cameraId","in":"path","schemaId":"schema_48","description":"the camera ID of the camera","required":true}],"pointer":"/paths/~1cameras~1{cameraId}~1opening-hours/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date","in":"query","schemaId":"schema_64","description":"Day of the year of requested Opening Hour"}],"pointer":"/paths/~1cameras~1{cameraId}~1opening-hours/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cameras/{cameraId}/opening-hours","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"cameraId","in":"path","required":true,"schemaId":"schema_48"}],"query":[{"name":"date","in":"query","schemaId":"schema_64"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/cameras/{cameraId}/opening-hours","href":"camera/getcameraopeninghour","openApiOperationId":"GetCameraOpeningHour","summary":"Get camera opening hour"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}},"schemaId":"schema_65"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1cameras~1{cameraId}~1opening-hours/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_65","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/camera/getcameraopeninghour"}],"panels":[]}]},"httpPath":"/cameras/{cameraId}/opening-hours"},{"label":"Change camera state","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/camera/putcamerastate","routeSlug":"/v1/camera/putcamerastate","metadata":{"seo":{"title":"Change camera state","description":"Change the state of a camera from running to paused or vice-versa."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutCameraState","name":"Change camera state","isWebhook":false,"pointer":"/paths/~1cameras~1{cameraId}~1state~1{newState}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change camera state","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change the state of a camera from running to paused or vice-versa."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cameraId","in":"path","schemaId":"schema_48","description":"the camera ID of the camera.","required":true},{"name":"newState","in":"path","schemaId":"schema_66","description":"The state to which the camera will be set: running cameras are processing video and have notifications on,\npaused cameras are not processing video, notifications are off and can be re-activated.\n","required":true}],"pointer":"/paths/~1cameras~1{cameraId}~1state~1{newState}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/cameras/{cameraId}/state/{newState}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"cameraId","in":"path","required":true,"schemaId":"schema_48"},{"name":"newState","in":"path","required":true,"schemaId":"schema_66"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["201","401","403","404","422","500"],"pointer":"/cameras/{cameraId}/state/{newState}","href":"camera/putcamerastate","openApiOperationId":"PutCameraState","summary":"Change camera state"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK."},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1cameras~1{cameraId}~1state~1{newState}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201"},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/camera/putcamerastate"}],"panels":[]}]},"httpPath":"/cameras/{cameraId}/state/{newState}"},{"label":"Get video upload metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/camera/getvideouploadmetrics","routeSlug":"/v1/camera/getvideouploadmetrics","metadata":{"seo":{"title":"Get video upload metrics","description":"Get video upload metrics for the provided camera ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetVideoUploadMetrics","name":"Get video upload metrics","isWebhook":false,"pointer":"/paths/~1cameras~1{cameraId}~1video-upload-metrics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get video upload metrics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get video upload metrics for the provided camera ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"cameraId","in":"path","schemaId":"schema_48","description":"the camera ID of the camera","required":true}],"pointer":"/paths/~1cameras~1{cameraId}~1video-upload-metrics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cameras/{cameraId}/video-upload-metrics","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"cameraId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","500"],"pointer":"/cameras/{cameraId}/video-upload-metrics","href":"camera/getvideouploadmetrics","openApiOperationId":"GetVideoUploadMetrics","summary":"Get video upload metrics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VideoUploadMetrics"}},"schemaId":"components/schemas/VideoUploadMetrics"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1cameras~1{cameraId}~1video-upload-metrics/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VideoUploadMetrics","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VideoUploadMetrics"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/camera/getvideouploadmetrics"}],"panels":[]}]},"httpPath":"/cameras/{cameraId}/video-upload-metrics"},{"label":"Request live frame","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/camera/createframerequest","routeSlug":"/v1/camera/createframerequest","metadata":{"seo":{"title":"Request live frame","description":"Get a recent video frame from a camera."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateFrameRequest","name":"Request live frame","isWebhook":false,"pointer":"/paths/~1frame-requests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request live frame","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a recent video frame from a camera."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FrameRequest"}},"schemaId":"components/schemas/FrameRequest","pointer":"/paths/~1frame-requests/post/requestBody","description":"The FrameRequest that contains the camera to fetch a frame for."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/frame-requests","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FrameRequest"}},"responseCodes":["200","401","403","404","409","500"],"pointer":"/frame-requests","href":"camera/createframerequest","openApiOperationId":"CreateFrameRequest","summary":"Request live frame"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/FrameRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FrameRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Frame"}},"schemaId":"components/schemas/Frame"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"No image available.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"409","description":"Conflict.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"}],"pointer":"/paths/~1frame-requests/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Frame","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Frame"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"409","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/camera/createframerequest"}],"panels":[]}]},"httpPath":"/frame-requests"},{"label":"Change camera state","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/camera/putcamerastaterequest","routeSlug":"/v1/camera/putcamerastaterequest","metadata":{"seo":{"title":"Change camera state","description":"Change the state of a camera from claimed to claimed_paused or vice-versa."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutCameraStateRequest","name":"Change camera state","isWebhook":false,"pointer":"/paths/~1put-camera-state-requests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change camera state","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Change the state of a camera from claimed to claimed_paused or vice-versa."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_67"}},"schemaId":"schema_67","pointer":"/paths/~1put-camera-state-requests/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/put-camera-state-requests","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_67"}},"responseCodes":["202","401","403","404","422","500"],"pointer":"/put-camera-state-requests","href":"camera/putcamerastaterequest","openApiOperationId":"PutCameraStateRequest","summary":"Change camera state"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"schema_67","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_67"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}},"schemaId":"components/schemas/Job"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1put-camera-state-requests/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/Job","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/camera/putcamerastaterequest"}],"panels":[]}]},"httpPath":"/put-camera-state-requests"},{"label":"Register camera","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/camera/registercamerarequest","routeSlug":"/v1/camera/registercamerarequest","metadata":{"seo":{"title":"Register camera","description":"Create a camera in a registered state."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RegisterCameraRequest","name":"Register camera","isWebhook":false,"pointer":"/paths/~1register-camera-requests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register camera","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a camera in a registered state."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_68"}},"schemaId":"schema_68","pointer":"/paths/~1register-camera-requests/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/register-camera-requests","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_68"}},"responseCodes":["202","400","401","403","404","500"],"pointer":"/register-camera-requests","href":"camera/registercamerarequest","openApiOperationId":"RegisterCameraRequest","summary":"Register camera"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"schema_68","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_68"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}},"schemaId":"components/schemas/Job"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1register-camera-requests/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/Job","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Job"}}},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/camera/registercamerarequest"}],"panels":[]}]},"httpPath":"/register-camera-requests"}],"content":{"contentType":"group","meta":{"name":"camera"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cameras","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an organisation's cameras."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cameras","summary":"List cameras","prefix":{"name":"get","color":"get"},"badges":[],"link":"/camera/listcameras","deprecated":false},{"title":"/cameras","summary":"Link camera to organisation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/camera/createcamera","deprecated":false},{"title":"/cameras/{cameraId}","summary":"Delete camera","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/camera/deletecamera","deprecated":false},{"title":"/cameras/{cameraId}","summary":"Get camera","prefix":{"name":"get","color":"get"},"badges":[],"link":"/camera/getcamera","deprecated":false},{"title":"/cameras/{cameraId}","summary":"Patch camera","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/camera/patchcamera","deprecated":false},{"title":"/cameras/{cameraId}/move","summary":"Move camera","prefix":{"name":"post","color":"post"},"badges":[],"link":"/camera/movecamera","deprecated":false},{"title":"/cameras/{cameraId}/opening-hours","summary":"Get camera opening hour","prefix":{"name":"get","color":"get"},"badges":[],"link":"/camera/getcameraopeninghour","deprecated":false},{"title":"/cameras/{cameraId}/state/{newState}","summary":"Change camera state","prefix":{"name":"put","color":"put"},"badges":[],"link":"/camera/putcamerastate","deprecated":false},{"title":"/cameras/{cameraId}/video-upload-metrics","summary":"Get video upload metrics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/camera/getvideouploadmetrics","deprecated":false},{"title":"/frame-requests","summary":"Request live frame","prefix":{"name":"post","color":"post"},"badges":[],"link":"/camera/createframerequest","deprecated":false},{"title":"/put-camera-state-requests","summary":"Change camera state","prefix":{"name":"post","color":"post"},"badges":[],"link":"/camera/putcamerastaterequest","deprecated":false},{"title":"/register-camera-requests","summary":"Register camera","prefix":{"name":"post","color":"post"},"badges":[],"link":"/camera/registercamerarequest","deprecated":false}]}]}]}]}},{"type":"group","label":"Annotations","link":"/v1/annotation","routeSlug":"/v1/annotation","items":[{"label":"List annotations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/annotation/listannotations","routeSlug":"/v1/annotation/listannotations","metadata":{"seo":{"title":"List annotations","description":"Get all available annotations subject to filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListAnnotations","name":"List annotations","isWebhook":false,"pointer":"/paths/~1annotations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List annotations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all available annotations subject to filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cameraPositionId","in":"query","schemaId":"schema_48","description":"The ID of a camera position linked to the annotations."},{"name":"organisationId","in":"query","schemaId":"schema_48","description":"The ID of the associated organisation."},{"name":"siteId","in":"query","schemaId":"schema_48","description":"The ID of the associated site."},{"name":"state","in":"query","schemaId":"schema_57","description":"annotation state."}],"pointer":"/paths/~1annotations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/annotations","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"cameraPositionId","in":"query","schemaId":"schema_48"},{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"siteId","in":"query","schemaId":"schema_48"},{"name":"state","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500","501"],"pointer":"/annotations","href":"annotation/listannotations","openApiOperationId":"ListAnnotations","summary":"List annotations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_69"}},"schemaId":"schema_69"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1annotations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_69","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_69"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/annotation/listannotations"}],"panels":[]}]},"httpPath":"/annotations"},{"label":"Create/Update annotation","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/annotation/putannotation","routeSlug":"/v1/annotation/putannotation","metadata":{"seo":{"title":"Create/Update annotation","description":"Update an annotation if it exists, create a new one otherwise."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutAnnotation","name":"Create/Update annotation","isWebhook":false,"pointer":"/paths/~1annotations/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create/Update annotation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an annotation if it exists, create a new one otherwise."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Annotation"}},"schemaId":"components/schemas/Annotation","pointer":"/paths/~1annotations/put/requestBody","description":"The configuration for an annotation to store."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/annotations","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Annotation"}},"responseCodes":["201","204","400","401","403","410","422","500","501"],"pointer":"/annotations","href":"annotation/putannotation","openApiOperationId":"PutAnnotation","summary":"Create/Update annotation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/Annotation","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Annotation"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Annotation"}},"schemaId":"components/schemas/Annotation"},{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1annotations/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Annotation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Annotation"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/annotation/putannotation"}],"panels":[]}]},"httpPath":"/annotations"},{"label":"Delete annotation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/annotation/deleteannotation","routeSlug":"/v1/annotation/deleteannotation","metadata":{"seo":{"title":"Delete annotation","description":"Delete an annotation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAnnotation","name":"Delete annotation","isWebhook":false,"pointer":"/paths/~1annotations~1{annotationId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete annotation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an annotation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"annotationId","in":"path","schemaId":"schema_48","description":"The ID of the annotation to be deleted.","required":true}],"pointer":"/paths/~1annotations~1{annotationId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/annotations/{annotationId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"annotationId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","410","422","500","501"],"pointer":"/annotations/{annotationId}","href":"annotation/deleteannotation","openApiOperationId":"DeleteAnnotation","summary":"Delete annotation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1annotations~1{annotationId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/annotation/deleteannotation"}],"panels":[]}]},"httpPath":"/annotations/{annotationId}"},{"label":"Get annotation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/annotation/getannotation","routeSlug":"/v1/annotation/getannotation","metadata":{"seo":{"title":"Get annotation","description":"Get an annotation identified by its id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAnnotation","name":"Get annotation","isWebhook":false,"pointer":"/paths/~1annotations~1{annotationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get annotation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get an annotation identified by its id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"annotationId","in":"path","schemaId":"schema_48","description":"The ID of the annotation to get.","required":true}],"pointer":"/paths/~1annotations~1{annotationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/annotations/{annotationId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"annotationId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","500","501"],"pointer":"/annotations/{annotationId}","href":"annotation/getannotation","openApiOperationId":"GetAnnotation","summary":"Get annotation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Annotation"}},"schemaId":"components/schemas/Annotation"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1annotations~1{annotationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Annotation","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Annotation"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/annotation/getannotation"}],"panels":[]}]},"httpPath":"/annotations/{annotationId}"}],"content":{"contentType":"group","meta":{"name":"annotation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Annotations","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an annotation."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/annotations","summary":"List annotations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/annotation/listannotations","deprecated":false},{"title":"/annotations","summary":"Create/Update annotation","prefix":{"name":"put","color":"put"},"badges":[],"link":"/annotation/putannotation","deprecated":false},{"title":"/annotations/{annotationId}","summary":"Delete annotation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/annotation/deleteannotation","deprecated":false},{"title":"/annotations/{annotationId}","summary":"Get annotation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/annotation/getannotation","deprecated":false}]}]}]}]}},{"type":"separator","label":"ALERT","content":null},{"type":"group","label":"Alert","link":"/v1/alert","routeSlug":"/v1/alert","items":[{"label":"List alerts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alert/listalerts","routeSlug":"/v1/alert/listalerts","metadata":{"seo":{"title":"List alerts","description":"Get all available alerts subject to filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListAlerts","name":"List alerts","isWebhook":false,"pointer":"/paths/~1alerts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List alerts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all available alerts subject to filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"alertType","in":"query","schemaId":"schema_70","description":"The ID of a camera linked to the Alerts."},{"name":"cameraPositionId","in":"query","schemaId":"schema_48","description":"The ID of a camera position linked to the alerts."},{"name":"notificationGroupId","in":"query","schemaId":"schema_48","description":"The ID of the notification group the alert are sent to."},{"name":"organisationId","in":"query","schemaId":"schema_48","description":"The ID of the associated organisation."},{"name":"occupancyMonitorId","in":"query","schemaId":"schema_48","description":"The ID of the associated occupancy monitor."},{"name":"siteId","in":"query","schemaId":"schema_48","description":"The ID of the associated site."},{"name":"state","in":"query","schemaId":"schema_57","description":"Alert state."}],"pointer":"/paths/~1alerts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/alerts","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"alertType","in":"query","schemaId":"schema_70"},{"name":"cameraPositionId","in":"query","schemaId":"schema_48"},{"name":"notificationGroupId","in":"query","schemaId":"schema_48"},{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"occupancyMonitorId","in":"query","schemaId":"schema_48"},{"name":"siteId","in":"query","schemaId":"schema_48"},{"name":"state","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500","501"],"pointer":"/alerts","href":"alert/listalerts","openApiOperationId":"ListAlerts","summary":"List alerts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_71"}},"schemaId":"schema_71"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alerts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_71","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_71"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert/listalerts"}],"panels":[]}]},"httpPath":"/alerts"},{"label":"Create/Update alert","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alert/putalert","routeSlug":"/v1/alert/putalert","metadata":{"seo":{"title":"Create/Update alert","description":"Update an alert if it exists, create a new one otherwise."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutAlert","name":"Create/Update alert","isWebhook":false,"pointer":"/paths/~1alerts/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create/Update alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an alert if it exists, create a new one otherwise."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Alert"}},"schemaId":"components/schemas/Alert","pointer":"/paths/~1alerts/put/requestBody","description":"The configuration for an alert to store."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/alerts","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Alert"}},"responseCodes":["201","204","400","401","403","410","422","500","501"],"pointer":"/alerts","href":"alert/putalert","openApiOperationId":"PutAlert","summary":"Create/Update alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/Alert","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Alert"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Alert"}},"schemaId":"components/schemas/Alert"},{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alerts/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Alert","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Alert"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert/putalert"}],"panels":[]}]},"httpPath":"/alerts"},{"label":"Delete alert","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alert/deletealert","routeSlug":"/v1/alert/deletealert","metadata":{"seo":{"title":"Delete alert","description":"Delete an alert."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAlert","name":"Delete alert","isWebhook":false,"pointer":"/paths/~1alerts~1{alertId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an alert."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"alertId","in":"path","schemaId":"schema_48","description":"The ID of the alert to be deleted.","required":true}],"pointer":"/paths/~1alerts~1{alertId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/alerts/{alertId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"alertId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","410","422","500","501"],"pointer":"/alerts/{alertId}","href":"alert/deletealert","openApiOperationId":"DeleteAlert","summary":"Delete alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alerts~1{alertId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert/deletealert"}],"panels":[]}]},"httpPath":"/alerts/{alertId}"},{"label":"Get alert","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alert/getalert","routeSlug":"/v1/alert/getalert","metadata":{"seo":{"title":"Get alert","description":"Get an alert identified by its id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetAlert","name":"Get alert","isWebhook":false,"pointer":"/paths/~1alerts~1{alertId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get an alert identified by its id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"alertId","in":"path","schemaId":"schema_48","description":"The ID of the alert to get.","required":true}],"pointer":"/paths/~1alerts~1{alertId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/alerts/{alertId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"alertId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","500","501"],"pointer":"/alerts/{alertId}","href":"alert/getalert","openApiOperationId":"GetAlert","summary":"Get alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Alert"}},"schemaId":"components/schemas/Alert"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alerts~1{alertId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Alert","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Alert"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert/getalert"}],"panels":[]}]},"httpPath":"/alerts/{alertId}"}],"content":{"contentType":"group","meta":{"name":"alert"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alert","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an organisation's alerts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/alerts","summary":"List alerts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alert/listalerts","deprecated":false},{"title":"/alerts","summary":"Create/Update alert","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alert/putalert","deprecated":false},{"title":"/alerts/{alertId}","summary":"Delete alert","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alert/deletealert","deprecated":false},{"title":"/alerts/{alertId}","summary":"Get alert","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alert/getalert","deprecated":false}]}]}]}]}},{"type":"group","label":"Alert Notification Groups","link":"/v1/alertnotificationgroup","routeSlug":"/v1/alertnotificationgroup","items":[{"label":"Delete an alert notification group link","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alertnotificationgroup/deletealertnotificationgroup","routeSlug":"/v1/alertnotificationgroup/deletealertnotificationgroup","metadata":{"seo":{"title":"Delete an alert notification group link","description":"Delete a link between an alert and a notification group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAlertNotificationGroup","name":"Delete an alert notification group link","isWebhook":false,"pointer":"/paths/~1alert-notification-groups/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an alert notification group link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a link between an alert and a notification group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"alertId","in":"query","schemaId":"schema_48","description":"The ID of the alert whose link is being deleted.","required":true},{"name":"notificationGroupId","in":"query","schemaId":"schema_48","description":"The ID of the notification group being unlinked from the alert.","required":true}],"pointer":"/paths/~1alert-notification-groups/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/alert-notification-groups","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"alertId","in":"query","required":true,"schemaId":"schema_48"},{"name":"notificationGroupId","in":"query","required":true,"schemaId":"schema_48"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500","501"],"pointer":"/alert-notification-groups","href":"alertnotificationgroup/deletealertnotificationgroup","openApiOperationId":"DeleteAlertNotificationGroup","summary":"Delete an alert notification group link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alert-notification-groups/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alertnotificationgroup/deletealertnotificationgroup"}],"panels":[]}]},"httpPath":"/alert-notification-groups"},{"label":"List alert notification group links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alertnotificationgroup/listalertnotificationgroups","routeSlug":"/v1/alertnotificationgroup/listalertnotificationgroups","metadata":{"seo":{"title":"List alert notification group links","description":"Get all available links between alerts and notification groups subject to filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListAlertNotificationGroups","name":"List alert notification group links","isWebhook":false,"pointer":"/paths/~1alert-notification-groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List alert notification group links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all available links between alerts and notification groups subject to filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cameraPositionId","in":"query","schemaId":"schema_48","description":"The ID of a camera position linked to the alert."},{"name":"notificationGroupId","in":"query","schemaId":"schema_48","description":"The ID of the notification group the alerts are linked to."},{"name":"alertId","in":"query","schemaId":"schema_48","description":"The ID of the alert the notification groups are linked to."},{"name":"organisationId","in":"query","schemaId":"schema_48","description":"The ID of the associated organisation."},{"name":"occupancyMonitorId","in":"query","schemaId":"schema_48","description":"the ID of the occupancy monitor the alert is linked to."},{"name":"alertType","in":"query","schemaId":"schema_70","description":"The type of the linked alert."},{"name":"siteId","in":"query","schemaId":"schema_48","description":"the ID of the site the linked alert is part of."}],"pointer":"/paths/~1alert-notification-groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/alert-notification-groups","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"cameraPositionId","in":"query","schemaId":"schema_48"},{"name":"notificationGroupId","in":"query","schemaId":"schema_48"},{"name":"alertId","in":"query","schemaId":"schema_48"},{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"occupancyMonitorId","in":"query","schemaId":"schema_48"},{"name":"alertType","in":"query","schemaId":"schema_70"},{"name":"siteId","in":"query","schemaId":"schema_48"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500","501"],"pointer":"/alert-notification-groups","href":"alertnotificationgroup/listalertnotificationgroups","openApiOperationId":"ListAlertNotificationGroups","summary":"List alert notification group links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_72"}},"schemaId":"schema_72"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alert-notification-groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_72","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_72"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alertnotificationgroup/listalertnotificationgroups"}],"panels":[]}]},"httpPath":"/alert-notification-groups"},{"label":"Create an alert notification group link","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alertnotificationgroup/putalertnotificationgroup","routeSlug":"/v1/alertnotificationgroup/putalertnotificationgroup","metadata":{"seo":{"title":"Create an alert notification group link","description":"Create a link between an alert and a notification group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutAlertNotificationGroup","name":"Create an alert notification group link","isWebhook":false,"pointer":"/paths/~1alert-notification-groups/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an alert notification group link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a link between an alert and a notification group."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlertNotificationGroup"}},"schemaId":"components/schemas/AlertNotificationGroup","pointer":"/paths/~1alert-notification-groups/put/requestBody","description":"The link between an alert and a notification group to store."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/alert-notification-groups","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AlertNotificationGroup"}},"responseCodes":["201","204","400","401","403","422","500","501"],"pointer":"/alert-notification-groups","href":"alertnotificationgroup/putalertnotificationgroup","openApiOperationId":"PutAlertNotificationGroup","summary":"Create an alert notification group link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/AlertNotificationGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlertNotificationGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertNotificationGroup"}},"schemaId":"components/schemas/AlertNotificationGroup"},{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alert-notification-groups/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AlertNotificationGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertNotificationGroup"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alertnotificationgroup/putalertnotificationgroup"}],"panels":[]}]},"httpPath":"/alert-notification-groups"}],"content":{"contentType":"group","meta":{"name":"alertNotificationGroup"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alert Notification Groups","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an organisation's alert notification group links."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/alert-notification-groups","summary":"Delete an alert notification group link","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alertnotificationgroup/deletealertnotificationgroup","deprecated":false},{"title":"/alert-notification-groups","summary":"List alert notification group links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alertnotificationgroup/listalertnotificationgroups","deprecated":false},{"title":"/alert-notification-groups","summary":"Create an alert notification group link","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alertnotificationgroup/putalertnotificationgroup","deprecated":false}]}]}]}]}},{"type":"group","label":"Alert Camera Positions","link":"/v1/alertcameraposition","routeSlug":"/v1/alertcameraposition","items":[{"label":"Delete an alert camera position link","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alertcameraposition/deletealertcameraposition","routeSlug":"/v1/alertcameraposition/deletealertcameraposition","metadata":{"seo":{"title":"Delete an alert camera position link","description":"Delete a link between an alert and a camera position."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAlertCameraPosition","name":"Delete an alert camera position link","isWebhook":false,"pointer":"/paths/~1alert-camera-positions/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an alert camera position link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a link between an alert and a camera position."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"alertId","in":"query","schemaId":"schema_48","description":"The ID of the alert whose link is being deleted.","required":true},{"name":"cameraPositionId","in":"query","schemaId":"schema_48","description":"The ID of the camera position being unlinked from the alert.","required":true}],"pointer":"/paths/~1alert-camera-positions/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/alert-camera-positions","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"alertId","in":"query","required":true,"schemaId":"schema_48"},{"name":"cameraPositionId","in":"query","required":true,"schemaId":"schema_48"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500","501"],"pointer":"/alert-camera-positions","href":"alertcameraposition/deletealertcameraposition","openApiOperationId":"DeleteAlertCameraPosition","summary":"Delete an alert camera position link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alert-camera-positions/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alertcameraposition/deletealertcameraposition"}],"panels":[]}]},"httpPath":"/alert-camera-positions"},{"label":"List alert camera position links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alertcameraposition/listalertcamerapositions","routeSlug":"/v1/alertcameraposition/listalertcamerapositions","metadata":{"seo":{"title":"List alert camera position links","description":"Get all available links between alerts and camera positions subject to filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListAlertCameraPositions","name":"List alert camera position links","isWebhook":false,"pointer":"/paths/~1alert-camera-positions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List alert camera position links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all available links between alerts and camera positions subject\nto filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cameraId","in":"query","schemaId":"schema_48","description":"The ID of a camera linked to the alerts."},{"name":"alertId","in":"query","schemaId":"schema_48","description":"The ID of an alert being linked to the camera positions."},{"name":"cameraPositionId","in":"query","schemaId":"schema_48","description":"The ID of a camera position linked to the alerts."},{"name":"notificationGroupId","in":"query","schemaId":"schema_48","description":"The ID of the notification group the linked alert notifies."},{"name":"organisationId","in":"query","schemaId":"schema_48","description":"The ID of the associated organisation."},{"name":"alertType","in":"query","schemaId":"schema_70","description":"The type of the linked alert."}],"pointer":"/paths/~1alert-camera-positions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/alert-camera-positions","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"cameraId","in":"query","schemaId":"schema_48"},{"name":"alertId","in":"query","schemaId":"schema_48"},{"name":"cameraPositionId","in":"query","schemaId":"schema_48"},{"name":"notificationGroupId","in":"query","schemaId":"schema_48"},{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"alertType","in":"query","schemaId":"schema_70"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500","501"],"pointer":"/alert-camera-positions","href":"alertcameraposition/listalertcamerapositions","openApiOperationId":"ListAlertCameraPositions","summary":"List alert camera position links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_73"}},"schemaId":"schema_73"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alert-camera-positions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_73","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_73"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alertcameraposition/listalertcamerapositions"}],"panels":[]}]},"httpPath":"/alert-camera-positions"},{"label":"Create an alert camera position link","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alertcameraposition/putalertcameraposition","routeSlug":"/v1/alertcameraposition/putalertcameraposition","metadata":{"seo":{"title":"Create an alert camera position link","description":"Create a link between an alert and a camera position."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutAlertCameraPosition","name":"Create an alert camera position link","isWebhook":false,"pointer":"/paths/~1alert-camera-positions/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an alert camera position link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a link between an alert and a camera position."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlertCameraPosition"}},"schemaId":"components/schemas/AlertCameraPosition","pointer":"/paths/~1alert-camera-positions/put/requestBody","description":"The link between an alert and a camera position to store."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/alert-camera-positions","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AlertCameraPosition"}},"responseCodes":["201","204","400","401","403","422","500","501"],"pointer":"/alert-camera-positions","href":"alertcameraposition/putalertcameraposition","openApiOperationId":"PutAlertCameraPosition","summary":"Create an alert camera position link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/AlertCameraPosition","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlertCameraPosition"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertCameraPosition"}},"schemaId":"components/schemas/AlertCameraPosition"},{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alert-camera-positions/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AlertCameraPosition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertCameraPosition"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alertcameraposition/putalertcameraposition"}],"panels":[]}]},"httpPath":"/alert-camera-positions"}],"content":{"contentType":"group","meta":{"name":"alertCameraPosition"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alert Camera Positions","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an organisation's alert camera position links."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/alert-camera-positions","summary":"Delete an alert camera position link","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alertcameraposition/deletealertcameraposition","deprecated":false},{"title":"/alert-camera-positions","summary":"List alert camera position links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alertcameraposition/listalertcamerapositions","deprecated":false},{"title":"/alert-camera-positions","summary":"Create an alert camera position link","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alertcameraposition/putalertcameraposition","deprecated":false}]}]}]}]}},{"type":"group","label":"Alert Occupancy Monitors","link":"/v1/alertoccupancymonitor","routeSlug":"/v1/alertoccupancymonitor","items":[{"label":"Delete an alert occupancy monitor link","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alertoccupancymonitor/deletealertoccupancymonitor","routeSlug":"/v1/alertoccupancymonitor/deletealertoccupancymonitor","metadata":{"seo":{"title":"Delete an alert occupancy monitor link","description":"Delete a link between an alert and an occupancy monitor."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAlertOccupancyMonitor","name":"Delete an alert occupancy monitor link","isWebhook":false,"pointer":"/paths/~1alert-occupancy-monitors/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an alert occupancy monitor link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a link between an alert and an occupancy monitor."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"alertId","in":"query","schemaId":"schema_48","description":"The ID of the alert whose link is being deleted.","required":true},{"name":"occupancyMonitorId","in":"query","schemaId":"schema_48","description":"The ID of the occupancy monitor being unlinked from the alert.","required":true}],"pointer":"/paths/~1alert-occupancy-monitors/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/alert-occupancy-monitors","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"alertId","in":"query","required":true,"schemaId":"schema_48"},{"name":"occupancyMonitorId","in":"query","required":true,"schemaId":"schema_48"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500","501"],"pointer":"/alert-occupancy-monitors","href":"alertoccupancymonitor/deletealertoccupancymonitor","openApiOperationId":"DeleteAlertOccupancyMonitor","summary":"Delete an alert occupancy monitor link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alert-occupancy-monitors/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alertoccupancymonitor/deletealertoccupancymonitor"}],"panels":[]}]},"httpPath":"/alert-occupancy-monitors"},{"label":"List alert occupancy monitor links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alertoccupancymonitor/listalertoccupancymonitors","routeSlug":"/v1/alertoccupancymonitor/listalertoccupancymonitors","metadata":{"seo":{"title":"List alert occupancy monitor links","description":"Get all links between alerts and occupancy monitors subject to filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListAlertOccupancyMonitors","name":"List alert occupancy monitor links","isWebhook":false,"pointer":"/paths/~1alert-occupancy-monitors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List alert occupancy monitor links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all links between alerts and occupancy monitors subject to filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"occupancyMonitorId","in":"query","schemaId":"schema_48","description":"the ID of the occupancy monitor the alert is linked to."},{"name":"alertId","in":"query","schemaId":"schema_48","description":"the ID of the alert the occupancy monitors are linked to."},{"name":"siteId","in":"query","schemaId":"schema_48","description":"the ID of the site the linked occupancy monitor is part of."},{"name":"organisationId","in":"query","schemaId":"schema_48","description":"the ID of the organisation the linked alert is part of."}],"pointer":"/paths/~1alert-occupancy-monitors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/alert-occupancy-monitors","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"occupancyMonitorId","in":"query","schemaId":"schema_48"},{"name":"alertId","in":"query","schemaId":"schema_48"},{"name":"siteId","in":"query","schemaId":"schema_48"},{"name":"organisationId","in":"query","schemaId":"schema_48"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500","501"],"pointer":"/alert-occupancy-monitors","href":"alertoccupancymonitor/listalertoccupancymonitors","openApiOperationId":"ListAlertOccupancyMonitors","summary":"List alert occupancy monitor links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_74"}},"schemaId":"schema_74"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alert-occupancy-monitors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_74","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_74"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alertoccupancymonitor/listalertoccupancymonitors"}],"panels":[]}]},"httpPath":"/alert-occupancy-monitors"},{"label":"Create an alert occupancy monitor link","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alertoccupancymonitor/putalertoccupancymonitor","routeSlug":"/v1/alertoccupancymonitor/putalertoccupancymonitor","metadata":{"seo":{"title":"Create an alert occupancy monitor link","description":"Create a link between an alert and an occupancy monitor."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutAlertOccupancyMonitor","name":"Create an alert occupancy monitor link","isWebhook":false,"pointer":"/paths/~1alert-occupancy-monitors/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an alert occupancy monitor link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a link between an alert and an occupancy monitor."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlertOccupancyMonitor"}},"schemaId":"components/schemas/AlertOccupancyMonitor","pointer":"/paths/~1alert-occupancy-monitors/put/requestBody","description":"The link between an alert and an occupancy monitor to store."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/alert-occupancy-monitors","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AlertOccupancyMonitor"}},"responseCodes":["201","204","400","401","403","422","500","501"],"pointer":"/alert-occupancy-monitors","href":"alertoccupancymonitor/putalertoccupancymonitor","openApiOperationId":"PutAlertOccupancyMonitor","summary":"Create an alert occupancy monitor link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/AlertOccupancyMonitor","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlertOccupancyMonitor"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertOccupancyMonitor"}},"schemaId":"components/schemas/AlertOccupancyMonitor"},{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alert-occupancy-monitors/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AlertOccupancyMonitor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertOccupancyMonitor"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alertoccupancymonitor/putalertoccupancymonitor"}],"panels":[]}]},"httpPath":"/alert-occupancy-monitors"}],"content":{"contentType":"group","meta":{"name":"alertOccupancyMonitor"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alert Occupancy Monitors","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an organisation's alert occupancy monitor links."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/alert-occupancy-monitors","summary":"Delete an alert occupancy monitor link","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alertoccupancymonitor/deletealertoccupancymonitor","deprecated":false},{"title":"/alert-occupancy-monitors","summary":"List alert occupancy monitor links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alertoccupancymonitor/listalertoccupancymonitors","deprecated":false},{"title":"/alert-occupancy-monitors","summary":"Create an alert occupancy monitor link","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alertoccupancymonitor/putalertoccupancymonitor","deprecated":false}]}]}]}]}},{"type":"group","label":"Alert Sites","link":"/v1/alertsite","routeSlug":"/v1/alertsite","items":[{"label":"Delete an alert site link","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alertsite/deletealertsite","routeSlug":"/v1/alertsite/deletealertsite","metadata":{"seo":{"title":"Delete an alert site link","description":"Delete a link between an alert and a site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteAlertSite","name":"Delete an alert site link","isWebhook":false,"pointer":"/paths/~1alert-sites/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an alert site link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete a link between an alert and a site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"alertId","in":"query","schemaId":"schema_48","description":"The ID of the alert whose link is being deleted.","required":true},{"name":"siteId","in":"query","schemaId":"schema_48","description":"The ID of the site being unlinked from the alert.","required":true}],"pointer":"/paths/~1alert-sites/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/alert-sites","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"alertId","in":"query","required":true,"schemaId":"schema_48"},{"name":"siteId","in":"query","required":true,"schemaId":"schema_48"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","500","501"],"pointer":"/alert-sites","href":"alertsite/deletealertsite","openApiOperationId":"DeleteAlertSite","summary":"Delete an alert site link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alert-sites/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alertsite/deletealertsite"}],"panels":[]}]},"httpPath":"/alert-sites"},{"label":"List alert site links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alertsite/listalertsites","routeSlug":"/v1/alertsite/listalertsites","metadata":{"seo":{"title":"List alert site links","description":"Get all links between alerts and sites subject to filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListAlertSites","name":"List alert site links","isWebhook":false,"pointer":"/paths/~1alert-sites/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List alert site links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all links between alerts and sites subject to filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"alertId","in":"query","schemaId":"schema_48","description":"The ID of the alert the sites are linked to."},{"name":"siteId","in":"query","schemaId":"schema_48","description":"The ID of a site linked to the alerts."},{"name":"organisationId","in":"query","schemaId":"schema_48","description":"The ID of the associated organisation."}],"pointer":"/paths/~1alert-sites/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/alert-sites","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"alertId","in":"query","schemaId":"schema_48"},{"name":"siteId","in":"query","schemaId":"schema_48"},{"name":"organisationId","in":"query","schemaId":"schema_48"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500","501"],"pointer":"/alert-sites","href":"alertsite/listalertsites","openApiOperationId":"ListAlertSites","summary":"List alert site links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_75"}},"schemaId":"schema_75"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alert-sites/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_75","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_75"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alertsite/listalertsites"}],"panels":[]}]},"httpPath":"/alert-sites"},{"label":"Create an alert site link","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/alertsite/putalertsite","routeSlug":"/v1/alertsite/putalertsite","metadata":{"seo":{"title":"Create an alert site link","description":"Create a link between an alert and a site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutAlertSite","name":"Create an alert site link","isWebhook":false,"pointer":"/paths/~1alert-sites/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an alert site link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a link between an alert and a site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlertSite"}},"schemaId":"components/schemas/AlertSite","pointer":"/paths/~1alert-sites/put/requestBody","description":"The link between an alert and a site to store."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/alert-sites","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AlertSite"}},"responseCodes":["201","204","400","401","403","422","500","501"],"pointer":"/alert-sites","href":"alertsite/putalertsite","openApiOperationId":"PutAlertSite","summary":"Create an alert site link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/AlertSite","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlertSite"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertSite"}},"schemaId":"components/schemas/AlertSite"},{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1alert-sites/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AlertSite","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertSite"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alertsite/putalertsite"}],"panels":[]}]},"httpPath":"/alert-sites"}],"content":{"contentType":"group","meta":{"name":"alertSite"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alert Sites","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an organisation's alert site links."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/alert-sites","summary":"Delete an alert site link","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alertsite/deletealertsite","deprecated":false},{"title":"/alert-sites","summary":"List alert site links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alertsite/listalertsites","deprecated":false},{"title":"/alert-sites","summary":"Create an alert site link","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alertsite/putalertsite","deprecated":false}]}]}]}]}},{"type":"separator","label":"NOTIFICATION GROUP","content":null},{"type":"group","label":"Notification Groups","link":"/v1/notificationgroup","routeSlug":"/v1/notificationgroup","items":[{"label":"List notification groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/notificationgroup/listnotificationgroups","routeSlug":"/v1/notificationgroup/listnotificationgroups","metadata":{"seo":{"title":"List notification groups","description":"Get all notification groups subject to filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListNotificationGroups","name":"List notification groups","isWebhook":false,"pointer":"/paths/~1notification-groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List notification groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all notification groups subject to filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"notificationGroupId","in":"query","schemaId":"schema_48","description":"The ID of the notification group to get."},{"name":"alertId","in":"query","schemaId":"schema_48","description":"The ID of the alert rule a notification group is linked to."},{"name":"organisationId","in":"query","schemaId":"schema_48","description":"The ID of the organisation the notification groups are linked to."},{"name":"state","in":"query","schemaId":"schema_57","description":"The state of the notification group."},{"name":"userId","in":"query","schemaId":"schema_54","description":"The ID of a user on whose visibility of the notification groups to filter on."}],"pointer":"/paths/~1notification-groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notification-groups","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"notificationGroupId","in":"query","schemaId":"schema_48"},{"name":"alertId","in":"query","schemaId":"schema_48"},{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"state","in":"query","schemaId":"schema_57"},{"name":"userId","in":"query","schemaId":"schema_54"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500"],"pointer":"/notification-groups","href":"notificationgroup/listnotificationgroups","openApiOperationId":"ListNotificationGroups","summary":"List notification groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76"}},"schemaId":"schema_76"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1notification-groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_76","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notificationgroup/listnotificationgroups"}],"panels":[]}]},"httpPath":"/notification-groups"},{"label":"Create/Update notification group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/notificationgroup/putnotificationgroup","routeSlug":"/v1/notificationgroup/putnotificationgroup","metadata":{"seo":{"title":"Create/Update notification group","description":"Update a notification group exists if exists, create a new one otherwise."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutNotificationGroup","name":"Create/Update notification group","isWebhook":false,"pointer":"/paths/~1notification-groups/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create/Update notification group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a notification group exists if exists, create a new one otherwise."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NotificationGroup"}},"schemaId":"components/schemas/NotificationGroup","pointer":"/paths/~1notification-groups/put/requestBody","description":"A notification group to send alerts to."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/notification-groups","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NotificationGroup"}},"responseCodes":["201","204","400","401","403","410","422","500"],"pointer":"/notification-groups","href":"notificationgroup/putnotificationgroup","openApiOperationId":"PutNotificationGroup","summary":"Create/Update notification group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/NotificationGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NotificationGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationGroup"}},"schemaId":"components/schemas/NotificationGroup"},{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1notification-groups/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/NotificationGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationGroup"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notificationgroup/putnotificationgroup"}],"panels":[]}]},"httpPath":"/notification-groups"},{"label":"Delete notification group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/notificationgroup/deletenotificationgroup","routeSlug":"/v1/notificationgroup/deletenotificationgroup","metadata":{"seo":{"title":"Delete notification group","description":"Set the state of a notification group to deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteNotificationGroup","name":"Delete notification group","isWebhook":false,"pointer":"/paths/~1notification-groups~1{notificationGroupId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete notification group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set the state of a notification group to deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"notificationGroupId","in":"path","schemaId":"schema_48","description":"the ID of the notification group to delete.","required":true}],"pointer":"/paths/~1notification-groups~1{notificationGroupId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/notification-groups/{notificationGroupId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"notificationGroupId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","410","422","500"],"pointer":"/notification-groups/{notificationGroupId}","href":"notificationgroup/deletenotificationgroup","openApiOperationId":"DeleteNotificationGroup","summary":"Delete notification group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1notification-groups~1{notificationGroupId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notificationgroup/deletenotificationgroup"}],"panels":[]}]},"httpPath":"/notification-groups/{notificationGroupId}"},{"label":"Get notification group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/notificationgroup/getnotificationgroup","routeSlug":"/v1/notificationgroup/getnotificationgroup","metadata":{"seo":{"title":"Get notification group","description":"Get a notification group identified by the provided ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetNotificationGroup","name":"Get notification group","isWebhook":false,"pointer":"/paths/~1notification-groups~1{notificationGroupId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get notification group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a notification group identified by the provided ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"notificationGroupId","in":"path","schemaId":"schema_48","description":"The ID of the notification group to get.","required":true}],"pointer":"/paths/~1notification-groups~1{notificationGroupId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notification-groups/{notificationGroupId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"notificationGroupId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","500"],"pointer":"/notification-groups/{notificationGroupId}","href":"notificationgroup/getnotificationgroup","openApiOperationId":"GetNotificationGroup","summary":"Get notification group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationGroup"}},"schemaId":"components/schemas/NotificationGroup"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1notification-groups~1{notificationGroupId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotificationGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationGroup"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notificationgroup/getnotificationgroup"}],"panels":[]}]},"httpPath":"/notification-groups/{notificationGroupId}"}],"content":{"contentType":"group","meta":{"name":"notificationGroup"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notification Groups","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an organisation's notification groups."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/notification-groups","summary":"List notification groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notificationgroup/listnotificationgroups","deprecated":false},{"title":"/notification-groups","summary":"Create/Update notification group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/notificationgroup/putnotificationgroup","deprecated":false},{"title":"/notification-groups/{notificationGroupId}","summary":"Delete notification group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/notificationgroup/deletenotificationgroup","deprecated":false},{"title":"/notification-groups/{notificationGroupId}","summary":"Get notification group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notificationgroup/getnotificationgroup","deprecated":false}]}]}]}]}},{"type":"group","label":"Notification Group Mappings","link":"/v1/notificationgroupmapping","routeSlug":"/v1/notificationgroupmapping","items":[{"label":"List notification group notification groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/notificationgroupmapping/listnotificationgroupnotificationgroups","routeSlug":"/v1/notificationgroupmapping/listnotificationgroupnotificationgroups","metadata":{"seo":{"title":"List notification group notification groups","description":"Get all notification groups link subject to filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListNotificationGroupNotificationGroups","name":"List notification group notification groups","isWebhook":false,"pointer":"/paths/~1notification-group-notification-groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List notification group notification groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all notification groups link subject to filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"notificationGroupNotificationGroupId","in":"query","schemaId":"schema_48","description":"The ID of the notification group link to get."},{"name":"parentNotificationGroupId","in":"query","schemaId":"schema_48","description":"The ID of the parent notification group to get all nested child IDs."},{"name":"childNotificationGroupId","in":"query","schemaId":"schema_48","description":"The ID of the child notification group to get all ancestral IDs."},{"name":"organisationId","in":"query","schemaId":"schema_48","description":"The ID of the organisation the notification group links are linked to."},{"name":"state","in":"query","schemaId":"schema_57","description":"The state of the notification group notification group link."}],"pointer":"/paths/~1notification-group-notification-groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notification-group-notification-groups","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"notificationGroupNotificationGroupId","in":"query","schemaId":"schema_48"},{"name":"parentNotificationGroupId","in":"query","schemaId":"schema_48"},{"name":"childNotificationGroupId","in":"query","schemaId":"schema_48"},{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"state","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500","501"],"pointer":"/notification-group-notification-groups","href":"notificationgroupmapping/listnotificationgroupnotificationgroups","openApiOperationId":"ListNotificationGroupNotificationGroups","summary":"List notification group notification groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}},"schemaId":"schema_77"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1notification-group-notification-groups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_77","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_77"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notificationgroupmapping/listnotificationgroupnotificationgroups"}],"panels":[]}]},"httpPath":"/notification-group-notification-groups"},{"label":"Create/Update notification group notification group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/notificationgroupmapping/putnotificationgroupnotificationgroup","routeSlug":"/v1/notificationgroupmapping/putnotificationgroupnotificationgroup","metadata":{"seo":{"title":"Create/Update notification group notification group","description":"Update existing notification group link, create a new one otherwise."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutNotificationGroupNotificationGroup","name":"Create/Update notification group notification group","isWebhook":false,"pointer":"/paths/~1notification-group-notification-groups/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create/Update notification group notification group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update existing notification group link, create a new one otherwise."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NotificationGroupNotificationGroup"}},"schemaId":"components/schemas/NotificationGroupNotificationGroup","pointer":"/paths/~1notification-group-notification-groups/put/requestBody","description":"A link between two notification groups."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/notification-group-notification-groups","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/NotificationGroupNotificationGroup"}},"responseCodes":["201","204","400","401","403","410","422","500","501"],"pointer":"/notification-group-notification-groups","href":"notificationgroupmapping/putnotificationgroupnotificationgroup","openApiOperationId":"PutNotificationGroupNotificationGroup","summary":"Create/Update notification group notification group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/NotificationGroupNotificationGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/NotificationGroupNotificationGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationGroupNotificationGroup"}},"schemaId":"components/schemas/NotificationGroupNotificationGroup"},{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1notification-group-notification-groups/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/NotificationGroupNotificationGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationGroupNotificationGroup"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notificationgroupmapping/putnotificationgroupnotificationgroup"}],"panels":[]}]},"httpPath":"/notification-group-notification-groups"},{"label":"Delete notification group notification group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/notificationgroupmapping/deletenotificationgroupnotificationgroup","routeSlug":"/v1/notificationgroupmapping/deletenotificationgroupnotificationgroup","metadata":{"seo":{"title":"Delete notification group notification group","description":"Set the state of a notification group link to deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteNotificationGroupNotificationGroup","name":"Delete notification group notification group","isWebhook":false,"pointer":"/paths/~1notification-group-notification-groups~1{notificationGroupNotificationGroupId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete notification group notification group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set the state of a notification group link to deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"notificationGroupNotificationGroupId","in":"path","schemaId":"schema_48","description":"the ID of the notification group link to delete.","required":true}],"pointer":"/paths/~1notification-group-notification-groups~1{notificationGroupNotificationGroupId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/notification-group-notification-groups/{notificationGroupNotificationGroupId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"notificationGroupNotificationGroupId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","410","422","500","501"],"pointer":"/notification-group-notification-groups/{notificationGroupNotificationGroupId}","href":"notificationgroupmapping/deletenotificationgroupnotificationgroup","openApiOperationId":"DeleteNotificationGroupNotificationGroup","summary":"Delete notification group notification group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1notification-group-notification-groups~1{notificationGroupNotificationGroupId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notificationgroupmapping/deletenotificationgroupnotificationgroup"}],"panels":[]}]},"httpPath":"/notification-group-notification-groups/{notificationGroupNotificationGroupId}"},{"label":"Get notification group notification group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/notificationgroupmapping/getnotificationgroupnotificationgroup","routeSlug":"/v1/notificationgroupmapping/getnotificationgroupnotificationgroup","metadata":{"seo":{"title":"Get notification group notification group","description":"Get a notification group link identified by the provided ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetNotificationGroupNotificationGroup","name":"Get notification group notification group","isWebhook":false,"pointer":"/paths/~1notification-group-notification-groups~1{notificationGroupNotificationGroupId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get notification group notification group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a notification group link identified by the provided ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"notificationGroupNotificationGroupId","in":"path","schemaId":"schema_48","description":"The ID of the notification group link to get.","required":true}],"pointer":"/paths/~1notification-group-notification-groups~1{notificationGroupNotificationGroupId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/notification-group-notification-groups/{notificationGroupNotificationGroupId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"notificationGroupNotificationGroupId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","500","501"],"pointer":"/notification-group-notification-groups/{notificationGroupNotificationGroupId}","href":"notificationgroupmapping/getnotificationgroupnotificationgroup","openApiOperationId":"GetNotificationGroupNotificationGroup","summary":"Get notification group notification group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationGroupNotificationGroup"}},"schemaId":"components/schemas/NotificationGroupNotificationGroup"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."},{"code":"501","description":"Not implemented."}],"pointer":"/paths/~1notification-group-notification-groups~1{notificationGroupNotificationGroupId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/NotificationGroupNotificationGroup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NotificationGroupNotificationGroup"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"},{"code":"501"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/notificationgroupmapping/getnotificationgroupnotificationgroup"}],"panels":[]}]},"httpPath":"/notification-group-notification-groups/{notificationGroupNotificationGroupId}"}],"content":{"contentType":"group","meta":{"name":"notificationGroupMapping"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Notification Group Mappings","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an organisation's notification group links."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/notification-group-notification-groups","summary":"List notification group notification groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notificationgroupmapping/listnotificationgroupnotificationgroups","deprecated":false},{"title":"/notification-group-notification-groups","summary":"Create/Update notification group notification group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/notificationgroupmapping/putnotificationgroupnotificationgroup","deprecated":false},{"title":"/notification-group-notification-groups/{notificationGroupNotificationGroupId}","summary":"Delete notification group notification group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/notificationgroupmapping/deletenotificationgroupnotificationgroup","deprecated":false},{"title":"/notification-group-notification-groups/{notificationGroupNotificationGroupId}","summary":"Get notification group notification group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/notificationgroupmapping/getnotificationgroupnotificationgroup","deprecated":false}]}]}]}]}},{"type":"separator","label":"OCCUPANCY MONITOR","content":null},{"type":"group","label":"Occupancy Monitors","link":"/v1/occupancymonitor","routeSlug":"/v1/occupancymonitor","items":[{"label":"List occupancy monitors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/occupancymonitor/listoccupancymonitors","routeSlug":"/v1/occupancymonitor/listoccupancymonitors","metadata":{"seo":{"title":"List occupancy monitors","description":"Get all available occupancy monitors subject to filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListOccupancyMonitors","name":"List occupancy monitors","isWebhook":false,"pointer":"/paths/~1occupancy-monitors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List occupancy monitors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all available occupancy monitors subject to filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"organisationId","in":"query","schemaId":"schema_48","description":"the ID of the associated organisation."},{"name":"siteId","in":"query","schemaId":"schema_48","description":"the ID of the site the occupancy monitors are linked to."},{"name":"cameraPositionId","in":"query","schemaId":"schema_48","description":"the ID of a camera position linked to the occupancy monitors."},{"name":"state","in":"query","schemaId":"schema_57","description":"Occupancy monitor state."}],"pointer":"/paths/~1occupancy-monitors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/occupancy-monitors","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"siteId","in":"query","schemaId":"schema_48"},{"name":"cameraPositionId","in":"query","schemaId":"schema_48"},{"name":"state","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500"],"pointer":"/occupancy-monitors","href":"occupancymonitor/listoccupancymonitors","openApiOperationId":"ListOccupancyMonitors","summary":"List occupancy monitors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}},"schemaId":"schema_78"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1occupancy-monitors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_78","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/occupancymonitor/listoccupancymonitors"}],"panels":[]}]},"httpPath":"/occupancy-monitors"},{"label":"Create/Update occupancy monitor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/occupancymonitor/putoccupancymonitor","routeSlug":"/v1/occupancymonitor/putoccupancymonitor","metadata":{"seo":{"title":"Create/Update occupancy monitor","description":"Update an occupancy monitor if it exists, create a new one otherwise."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutOccupancyMonitor","name":"Create/Update occupancy monitor","isWebhook":false,"pointer":"/paths/~1occupancy-monitors/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create/Update occupancy monitor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an occupancy monitor if it exists, create a new one otherwise."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OccupancyMonitor"}},"schemaId":"components/schemas/OccupancyMonitor","pointer":"/paths/~1occupancy-monitors/put/requestBody","description":"An occupancy monitor."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/occupancy-monitors","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OccupancyMonitor"}},"responseCodes":["201","204","400","401","403","410","422","500"],"pointer":"/occupancy-monitors","href":"occupancymonitor/putoccupancymonitor","openApiOperationId":"PutOccupancyMonitor","summary":"Create/Update occupancy monitor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/OccupancyMonitor","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OccupancyMonitor"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OccupancyMonitor"}},"schemaId":"components/schemas/OccupancyMonitor"},{"code":"204","description":"No Content."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1occupancy-monitors/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/OccupancyMonitor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OccupancyMonitor"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/occupancymonitor/putoccupancymonitor"}],"panels":[]}]},"httpPath":"/occupancy-monitors"},{"label":"Delete occupancy monitor","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/occupancymonitor/deleteoccupancymonitor","routeSlug":"/v1/occupancymonitor/deleteoccupancymonitor","metadata":{"seo":{"title":"Delete occupancy monitor","description":"Set the state of an occupancy monitor to deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteOccupancyMonitor","name":"Delete occupancy monitor","isWebhook":false,"pointer":"/paths/~1occupancy-monitors~1{occupancyMonitorId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete occupancy monitor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set the state of an occupancy monitor to deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"occupancyMonitorId","in":"path","schemaId":"schema_48","description":"the ID of the occupancy monitor.","required":true}],"pointer":"/paths/~1occupancy-monitors~1{occupancyMonitorId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/occupancy-monitors/{occupancyMonitorId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"occupancyMonitorId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","410","422","500"],"pointer":"/occupancy-monitors/{occupancyMonitorId}","href":"occupancymonitor/deleteoccupancymonitor","openApiOperationId":"DeleteOccupancyMonitor","summary":"Delete occupancy monitor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1occupancy-monitors~1{occupancyMonitorId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/occupancymonitor/deleteoccupancymonitor"}],"panels":[]}]},"httpPath":"/occupancy-monitors/{occupancyMonitorId}"},{"label":"Get occupancy monitor","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/occupancymonitor/getoccupancymonitor","routeSlug":"/v1/occupancymonitor/getoccupancymonitor","metadata":{"seo":{"title":"Get occupancy monitor","description":"Get an occupancy monitor identified by the provided ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetOccupancyMonitor","name":"Get occupancy monitor","isWebhook":false,"pointer":"/paths/~1occupancy-monitors~1{occupancyMonitorId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get occupancy monitor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get an occupancy monitor identified by the provided ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"occupancyMonitorId","in":"path","schemaId":"schema_48","description":"The ID of the Occupancy Monitor.","required":true}],"pointer":"/paths/~1occupancy-monitors~1{occupancyMonitorId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/occupancy-monitors/{occupancyMonitorId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"occupancyMonitorId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","500"],"pointer":"/occupancy-monitors/{occupancyMonitorId}","href":"occupancymonitor/getoccupancymonitor","openApiOperationId":"GetOccupancyMonitor","summary":"Get occupancy monitor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OccupancyMonitor"}},"schemaId":"components/schemas/OccupancyMonitor"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1occupancy-monitors~1{occupancyMonitorId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OccupancyMonitor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OccupancyMonitor"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/occupancymonitor/getoccupancymonitor"}],"panels":[]}]},"httpPath":"/occupancy-monitors/{occupancyMonitorId}"}],"content":{"contentType":"group","meta":{"name":"occupancyMonitor"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Occupancy Monitors","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an Organisation's occupancy monitors."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/occupancy-monitors","summary":"List occupancy monitors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/occupancymonitor/listoccupancymonitors","deprecated":false},{"title":"/occupancy-monitors","summary":"Create/Update occupancy monitor","prefix":{"name":"put","color":"put"},"badges":[],"link":"/occupancymonitor/putoccupancymonitor","deprecated":false},{"title":"/occupancy-monitors/{occupancyMonitorId}","summary":"Delete occupancy monitor","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/occupancymonitor/deleteoccupancymonitor","deprecated":false},{"title":"/occupancy-monitors/{occupancyMonitorId}","summary":"Get occupancy monitor","prefix":{"name":"get","color":"get"},"badges":[],"link":"/occupancymonitor/getoccupancymonitor","deprecated":false}]}]}]}]}},{"type":"group","label":"Occupancy Monitor Camera Positions","link":"/v1/occupancymonitorcameraposition","routeSlug":"/v1/occupancymonitorcameraposition","items":[{"label":"List occupancy monitor camera positions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/occupancymonitorcameraposition/listoccupancymonitorcamerapositions","routeSlug":"/v1/occupancymonitorcameraposition/listoccupancymonitorcamerapositions","metadata":{"seo":{"title":"List occupancy monitor camera positions","description":"Get all available occupancy monitor camera positions subject to filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListOccupancyMonitorCameraPositions","name":"List occupancy monitor camera positions","isWebhook":false,"pointer":"/paths/~1occupancy-monitor-camera-positions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List occupancy monitor camera positions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all available occupancy monitor camera positions subject to filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"organisationId","in":"query","schemaId":"schema_48","description":"the ID of the associated organisation."},{"name":"siteId","in":"query","schemaId":"schema_48","description":"the ID of the site the occupancy monitor camera positions are linked to."},{"name":"cameraId","in":"query","schemaId":"schema_48","description":"the ID of a camera linked to the occupancy monitor camera positions."},{"name":"occupancyMonitorId","in":"query","schemaId":"schema_48","description":"the ID of the occupancy monitor the occupancy monitor camera position is linking."},{"name":"state","in":"query","schemaId":"schema_57","description":"Occupancy monitor camera position state."}],"pointer":"/paths/~1occupancy-monitor-camera-positions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/occupancy-monitor-camera-positions","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"siteId","in":"query","schemaId":"schema_48"},{"name":"cameraId","in":"query","schemaId":"schema_48"},{"name":"occupancyMonitorId","in":"query","schemaId":"schema_48"},{"name":"state","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500"],"pointer":"/occupancy-monitor-camera-positions","href":"occupancymonitorcameraposition/listoccupancymonitorcamerapositions","openApiOperationId":"ListOccupancyMonitorCameraPositions","summary":"List occupancy monitor camera positions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}},"schemaId":"schema_79"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1occupancy-monitor-camera-positions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_79","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/occupancymonitorcameraposition/listoccupancymonitorcamerapositions"}],"panels":[]}]},"httpPath":"/occupancy-monitor-camera-positions"},{"label":"Create/Update occupancy monitor camera position","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/occupancymonitorcameraposition/putoccupancymonitorcameraposition","routeSlug":"/v1/occupancymonitorcameraposition/putoccupancymonitorcameraposition","metadata":{"seo":{"title":"Create/Update occupancy monitor camera position","description":"Update an occupancy monitor's camera position if it exists, create a new object linking the given occupancy monitor to the given camera position otherwise."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutOccupancyMonitorCameraPosition","name":"Create/Update occupancy monitor camera position","isWebhook":false,"pointer":"/paths/~1occupancy-monitor-camera-positions/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create/Update occupancy monitor camera position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update an occupancy monitor's camera position if it exists, create a new\nobject linking the given occupancy monitor to the given camera position otherwise."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OccupancyMonitorCameraPosition"}},"schemaId":"components/schemas/OccupancyMonitorCameraPosition","pointer":"/paths/~1occupancy-monitor-camera-positions/put/requestBody","description":"An occupancy monitor camera position."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/occupancy-monitor-camera-positions","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OccupancyMonitorCameraPosition"}},"responseCodes":["201","204","400","401","403","410","422","500"],"pointer":"/occupancy-monitor-camera-positions","href":"occupancymonitorcameraposition/putoccupancymonitorcameraposition","openApiOperationId":"PutOccupancyMonitorCameraPosition","summary":"Create/Update occupancy monitor camera position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/OccupancyMonitorCameraPosition","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OccupancyMonitorCameraPosition"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OccupancyMonitorCameraPosition"}},"schemaId":"components/schemas/OccupancyMonitorCameraPosition"},{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1occupancy-monitor-camera-positions/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/OccupancyMonitorCameraPosition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OccupancyMonitorCameraPosition"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/occupancymonitorcameraposition/putoccupancymonitorcameraposition"}],"panels":[]}]},"httpPath":"/occupancy-monitor-camera-positions"},{"label":"Delete occupancy monitor camera position","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/occupancymonitorcameraposition/deleteoccupancymonitorcameraposition","routeSlug":"/v1/occupancymonitorcameraposition/deleteoccupancymonitorcameraposition","metadata":{"seo":{"title":"Delete occupancy monitor camera position","description":"Set the state of an occupancy monitor camera position to deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteOccupancyMonitorCameraPosition","name":"Delete occupancy monitor camera position","isWebhook":false,"pointer":"/paths/~1occupancy-monitor-camera-positions~1{occupancyMonitorCameraPositionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete occupancy monitor camera position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set the state of an occupancy monitor camera position to deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"occupancyMonitorCameraPositionId","in":"path","schemaId":"schema_48","description":"the ID of the occupancy monitor camera position to delete.","required":true}],"pointer":"/paths/~1occupancy-monitor-camera-positions~1{occupancyMonitorCameraPositionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/occupancy-monitor-camera-positions/{occupancyMonitorCameraPositionId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"occupancyMonitorCameraPositionId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","410","422","500"],"pointer":"/occupancy-monitor-camera-positions/{occupancyMonitorCameraPositionId}","href":"occupancymonitorcameraposition/deleteoccupancymonitorcameraposition","openApiOperationId":"DeleteOccupancyMonitorCameraPosition","summary":"Delete occupancy monitor camera position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1occupancy-monitor-camera-positions~1{occupancyMonitorCameraPositionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/occupancymonitorcameraposition/deleteoccupancymonitorcameraposition"}],"panels":[]}]},"httpPath":"/occupancy-monitor-camera-positions/{occupancyMonitorCameraPositionId}"},{"label":"Get occupancy monitor camera position","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/occupancymonitorcameraposition/getoccupancymonitorcameraposition","routeSlug":"/v1/occupancymonitorcameraposition/getoccupancymonitorcameraposition","metadata":{"seo":{"title":"Get occupancy monitor camera position","description":"Get an occupancy monitor camera position identified by the provided ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetOccupancyMonitorCameraPosition","name":"Get occupancy monitor camera position","isWebhook":false,"pointer":"/paths/~1occupancy-monitor-camera-positions~1{occupancyMonitorCameraPositionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get occupancy monitor camera position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get an occupancy monitor camera position identified by the provided ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"occupancyMonitorCameraPositionId","in":"path","schemaId":"schema_48","description":"The ID of the occupancy monitor camera position.","required":true}],"pointer":"/paths/~1occupancy-monitor-camera-positions~1{occupancyMonitorCameraPositionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/occupancy-monitor-camera-positions/{occupancyMonitorCameraPositionId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"occupancyMonitorCameraPositionId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","500"],"pointer":"/occupancy-monitor-camera-positions/{occupancyMonitorCameraPositionId}","href":"occupancymonitorcameraposition/getoccupancymonitorcameraposition","openApiOperationId":"GetOccupancyMonitorCameraPosition","summary":"Get occupancy monitor camera position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OccupancyMonitorCameraPosition"}},"schemaId":"components/schemas/OccupancyMonitorCameraPosition"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1occupancy-monitor-camera-positions~1{occupancyMonitorCameraPositionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/OccupancyMonitorCameraPosition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OccupancyMonitorCameraPosition"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/occupancymonitorcameraposition/getoccupancymonitorcameraposition"}],"panels":[]}]},"httpPath":"/occupancy-monitor-camera-positions/{occupancyMonitorCameraPositionId}"}],"content":{"contentType":"group","meta":{"name":"occupancyMonitorCameraPosition"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Occupancy Monitor Camera Positions","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an Organisation's occupancy monitor camera positions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/occupancy-monitor-camera-positions","summary":"List occupancy monitor camera positions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/occupancymonitorcameraposition/listoccupancymonitorcamerapositions","deprecated":false},{"title":"/occupancy-monitor-camera-positions","summary":"Create/Update occupancy monitor camera position","prefix":{"name":"put","color":"put"},"badges":[],"link":"/occupancymonitorcameraposition/putoccupancymonitorcameraposition","deprecated":false},{"title":"/occupancy-monitor-camera-positions/{occupancyMonitorCameraPositionId}","summary":"Delete occupancy monitor camera position","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/occupancymonitorcameraposition/deleteoccupancymonitorcameraposition","deprecated":false},{"title":"/occupancy-monitor-camera-positions/{occupancyMonitorCameraPositionId}","summary":"Get occupancy monitor camera position","prefix":{"name":"get","color":"get"},"badges":[],"link":"/occupancymonitorcameraposition/getoccupancymonitorcameraposition","deprecated":false}]}]}]}]}},{"type":"separator","label":"PEOPLE-COUNT MONITOR","content":null},{"type":"group","label":"People Count Monitors","link":"/v1/peoplecountmonitor","routeSlug":"/v1/peoplecountmonitor","items":[{"label":"List people count monitors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peoplecountmonitor/listpeoplecountmonitors","routeSlug":"/v1/peoplecountmonitor/listpeoplecountmonitors","metadata":{"seo":{"title":"List people count monitors","description":"Get all available occupancy monitors subject to filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListPeopleCountMonitors","name":"List people count monitors","isWebhook":false,"pointer":"/paths/~1people-count-monitors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List people count monitors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all available occupancy monitors subject to filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"organisationId","in":"query","schemaId":"schema_48","description":"the ID of the associated organisation."},{"name":"siteId","in":"query","schemaId":"schema_48","description":"the ID of the site the people count monitors are linked to."},{"name":"cameraPositionId","in":"query","schemaId":"schema_48","description":"the ID of a camera position linked to the people count monitors."},{"name":"state","in":"query","schemaId":"schema_57","description":"People count monitors state."}],"pointer":"/paths/~1people-count-monitors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people-count-monitors","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"siteId","in":"query","schemaId":"schema_48"},{"name":"cameraPositionId","in":"query","schemaId":"schema_48"},{"name":"state","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500"],"pointer":"/people-count-monitors","href":"peoplecountmonitor/listpeoplecountmonitors","openApiOperationId":"ListPeopleCountMonitors","summary":"List people count monitors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}},"schemaId":"schema_80"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1people-count-monitors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_80","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peoplecountmonitor/listpeoplecountmonitors"}],"panels":[]}]},"httpPath":"/people-count-monitors"},{"label":"Create/Update people count monitor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peoplecountmonitor/putpeoplecountmonitor","routeSlug":"/v1/peoplecountmonitor/putpeoplecountmonitor","metadata":{"seo":{"title":"Create/Update people count monitor","description":"Update a people count monitor if it exists, create a new one otherwise."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutPeopleCountMonitor","name":"Create/Update people count monitor","isWebhook":false,"pointer":"/paths/~1people-count-monitors/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create/Update people count monitor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a people count monitor if it exists, create a new one otherwise."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PeopleCountMonitor"}},"schemaId":"components/schemas/PeopleCountMonitor","pointer":"/paths/~1people-count-monitors/put/requestBody","description":"A people count monitor to put."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people-count-monitors","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PeopleCountMonitor"}},"responseCodes":["201","204","400","401","403","410","422","500"],"pointer":"/people-count-monitors","href":"peoplecountmonitor/putpeoplecountmonitor","openApiOperationId":"PutPeopleCountMonitor","summary":"Create/Update people count monitor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/PeopleCountMonitor","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PeopleCountMonitor"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeopleCountMonitor"}},"schemaId":"components/schemas/PeopleCountMonitor"},{"code":"204","description":"Updated."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1people-count-monitors/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PeopleCountMonitor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeopleCountMonitor"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peoplecountmonitor/putpeoplecountmonitor"}],"panels":[]}]},"httpPath":"/people-count-monitors"},{"label":"Delete people count monitor","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peoplecountmonitor/deletepeoplecountmonitor","routeSlug":"/v1/peoplecountmonitor/deletepeoplecountmonitor","metadata":{"seo":{"title":"Delete people count monitor","description":"Set the state of a people count monitor to deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePeopleCountMonitor","name":"Delete people count monitor","isWebhook":false,"pointer":"/paths/~1people-count-monitors~1{peopleCountMonitorId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete people count monitor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set the state of a people count monitor to deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"peopleCountMonitorId","in":"path","schemaId":"schema_48","description":"the ID of the people count monitor to delete.","required":true}],"pointer":"/paths/~1people-count-monitors~1{peopleCountMonitorId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people-count-monitors/{peopleCountMonitorId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"peopleCountMonitorId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","410","422","500"],"pointer":"/people-count-monitors/{peopleCountMonitorId}","href":"peoplecountmonitor/deletepeoplecountmonitor","openApiOperationId":"DeletePeopleCountMonitor","summary":"Delete people count monitor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1people-count-monitors~1{peopleCountMonitorId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peoplecountmonitor/deletepeoplecountmonitor"}],"panels":[]}]},"httpPath":"/people-count-monitors/{peopleCountMonitorId}"},{"label":"Get people count monitor","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peoplecountmonitor/getpeoplecountmonitor","routeSlug":"/v1/peoplecountmonitor/getpeoplecountmonitor","metadata":{"seo":{"title":"Get people count monitor","description":"Get a people count monitor identified by the provided ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPeopleCountMonitor","name":"Get people count monitor","isWebhook":false,"pointer":"/paths/~1people-count-monitors~1{peopleCountMonitorId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get people count monitor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a people count monitor identified by the provided ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"peopleCountMonitorId","in":"path","schemaId":"schema_48","description":"The ID of the people count monitor.","required":true}],"pointer":"/paths/~1people-count-monitors~1{peopleCountMonitorId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people-count-monitors/{peopleCountMonitorId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"peopleCountMonitorId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","500"],"pointer":"/people-count-monitors/{peopleCountMonitorId}","href":"peoplecountmonitor/getpeoplecountmonitor","openApiOperationId":"GetPeopleCountMonitor","summary":"Get people count monitor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeopleCountMonitor"}},"schemaId":"components/schemas/PeopleCountMonitor"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1people-count-monitors~1{peopleCountMonitorId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PeopleCountMonitor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeopleCountMonitor"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peoplecountmonitor/getpeoplecountmonitor"}],"panels":[]}]},"httpPath":"/people-count-monitors/{peopleCountMonitorId}"}],"content":{"contentType":"group","meta":{"name":"peopleCountMonitor"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"People Count Monitors","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an Organisation's people count monitors."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people-count-monitors","summary":"List people count monitors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/peoplecountmonitor/listpeoplecountmonitors","deprecated":false},{"title":"/people-count-monitors","summary":"Create/Update people count monitor","prefix":{"name":"put","color":"put"},"badges":[],"link":"/peoplecountmonitor/putpeoplecountmonitor","deprecated":false},{"title":"/people-count-monitors/{peopleCountMonitorId}","summary":"Delete people count monitor","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/peoplecountmonitor/deletepeoplecountmonitor","deprecated":false},{"title":"/people-count-monitors/{peopleCountMonitorId}","summary":"Get people count monitor","prefix":{"name":"get","color":"get"},"badges":[],"link":"/peoplecountmonitor/getpeoplecountmonitor","deprecated":false}]}]}]}]}},{"type":"group","label":"People Count Monitor Camera Positions","link":"/v1/peoplecountmonitorcameraposition","routeSlug":"/v1/peoplecountmonitorcameraposition","items":[{"label":"List people count monitor camera positions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peoplecountmonitorcameraposition/listpeoplecountmonitorcamerapositions","routeSlug":"/v1/peoplecountmonitorcameraposition/listpeoplecountmonitorcamerapositions","metadata":{"seo":{"title":"List people count monitor camera positions","description":"Get all available occupancy monitor camera positions subject to filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListPeopleCountMonitorCameraPositions","name":"List people count monitor camera positions","isWebhook":false,"pointer":"/paths/~1people-count-monitor-camera-positions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List people count monitor camera positions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all available occupancy monitor camera positions subject to filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"organisationId","in":"query","schemaId":"schema_48","description":"the ID of the associated organisation."},{"name":"siteId","in":"query","schemaId":"schema_48","description":"the ID of the site the people count monitor camera positions are linked to."},{"name":"cameraPositionId","in":"query","schemaId":"schema_48","description":"the ID of a camera position linked to the people count monitor camera positions."},{"name":"peopleCountMonitorId","in":"query","schemaId":"schema_48","description":"the ID of the people count monitor the people count monitor camera position is linking."},{"name":"state","in":"query","schemaId":"schema_57","description":"People count monitor camera positions state filter."}],"pointer":"/paths/~1people-count-monitor-camera-positions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people-count-monitor-camera-positions","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"siteId","in":"query","schemaId":"schema_48"},{"name":"cameraPositionId","in":"query","schemaId":"schema_48"},{"name":"peopleCountMonitorId","in":"query","schemaId":"schema_48"},{"name":"state","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500"],"pointer":"/people-count-monitor-camera-positions","href":"peoplecountmonitorcameraposition/listpeoplecountmonitorcamerapositions","openApiOperationId":"ListPeopleCountMonitorCameraPositions","summary":"List people count monitor camera positions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_81"}},"schemaId":"schema_81"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1people-count-monitor-camera-positions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_81","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_81"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peoplecountmonitorcameraposition/listpeoplecountmonitorcamerapositions"}],"panels":[]}]},"httpPath":"/people-count-monitor-camera-positions"},{"label":"Create/Update people count monitor camera position","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peoplecountmonitorcameraposition/putpeoplecountmonitorcameraposition","routeSlug":"/v1/peoplecountmonitorcameraposition/putpeoplecountmonitorcameraposition","metadata":{"seo":{"title":"Create/Update people count monitor camera position","description":"Update a people count monitor's camera position if it exists, create a new object linking the given people count monitor to the given camera position otherwise."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutPeopleCountMonitorCameraPosition","name":"Create/Update people count monitor camera position","isWebhook":false,"pointer":"/paths/~1people-count-monitor-camera-positions/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create/Update people count monitor camera position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a people count monitor's camera position if it exists, create a new\nobject linking the given people count monitor to the given camera position otherwise."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PeopleCountMonitorCameraPosition"}},"schemaId":"components/schemas/PeopleCountMonitorCameraPosition","pointer":"/paths/~1people-count-monitor-camera-positions/put/requestBody","description":"A people count monitor camera position to put."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/people-count-monitor-camera-positions","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PeopleCountMonitorCameraPosition"}},"responseCodes":["201","204","400","401","403","410","422","500"],"pointer":"/people-count-monitor-camera-positions","href":"peoplecountmonitorcameraposition/putpeoplecountmonitorcameraposition","openApiOperationId":"PutPeopleCountMonitorCameraPosition","summary":"Create/Update people count monitor camera position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/PeopleCountMonitorCameraPosition","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PeopleCountMonitorCameraPosition"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeopleCountMonitorCameraPosition"}},"schemaId":"components/schemas/PeopleCountMonitorCameraPosition"},{"code":"204","description":"Updated."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1people-count-monitor-camera-positions/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PeopleCountMonitorCameraPosition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeopleCountMonitorCameraPosition"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peoplecountmonitorcameraposition/putpeoplecountmonitorcameraposition"}],"panels":[]}]},"httpPath":"/people-count-monitor-camera-positions"},{"label":"Delete people count monitor camera position","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peoplecountmonitorcameraposition/deletepeoplecountmonitorcameraposition","routeSlug":"/v1/peoplecountmonitorcameraposition/deletepeoplecountmonitorcameraposition","metadata":{"seo":{"title":"Delete people count monitor camera position","description":"Set the state of a people count monitor camera position to deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePeopleCountMonitorCameraPosition","name":"Delete people count monitor camera position","isWebhook":false,"pointer":"/paths/~1people-count-monitor-camera-positions~1{peopleCountMonitorCameraPositionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete people count monitor camera position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set the state of a people count monitor camera position to deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"peopleCountMonitorCameraPositionId","in":"path","schemaId":"schema_48","description":"the ID of the people count monitor camera position to delete.","required":true}],"pointer":"/paths/~1people-count-monitor-camera-positions~1{peopleCountMonitorCameraPositionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/people-count-monitor-camera-positions/{peopleCountMonitorCameraPositionId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"peopleCountMonitorCameraPositionId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","410","422","500"],"pointer":"/people-count-monitor-camera-positions/{peopleCountMonitorCameraPositionId}","href":"peoplecountmonitorcameraposition/deletepeoplecountmonitorcameraposition","openApiOperationId":"DeletePeopleCountMonitorCameraPosition","summary":"Delete people count monitor camera position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1people-count-monitor-camera-positions~1{peopleCountMonitorCameraPositionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peoplecountmonitorcameraposition/deletepeoplecountmonitorcameraposition"}],"panels":[]}]},"httpPath":"/people-count-monitor-camera-positions/{peopleCountMonitorCameraPositionId}"},{"label":"Get people count monitor camera position","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peoplecountmonitorcameraposition/getpeoplecountmonitorcameraposition","routeSlug":"/v1/peoplecountmonitorcameraposition/getpeoplecountmonitorcameraposition","metadata":{"seo":{"title":"Get people count monitor camera position","description":"Get a people count monitor camera position identified by the provided ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPeopleCountMonitorCameraPosition","name":"Get people count monitor camera position","isWebhook":false,"pointer":"/paths/~1people-count-monitor-camera-positions~1{peopleCountMonitorCameraPositionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get people count monitor camera position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a people count monitor camera position identified by the provided ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"peopleCountMonitorCameraPositionId","in":"path","schemaId":"schema_48","description":"The ID of the people count monitor camera position to get.","required":true}],"pointer":"/paths/~1people-count-monitor-camera-positions~1{peopleCountMonitorCameraPositionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/people-count-monitor-camera-positions/{peopleCountMonitorCameraPositionId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"peopleCountMonitorCameraPositionId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","500"],"pointer":"/people-count-monitor-camera-positions/{peopleCountMonitorCameraPositionId}","href":"peoplecountmonitorcameraposition/getpeoplecountmonitorcameraposition","openApiOperationId":"GetPeopleCountMonitorCameraPosition","summary":"Get people count monitor camera position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeopleCountMonitorCameraPosition"}},"schemaId":"components/schemas/PeopleCountMonitorCameraPosition"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1people-count-monitor-camera-positions~1{peopleCountMonitorCameraPositionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PeopleCountMonitorCameraPosition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeopleCountMonitorCameraPosition"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peoplecountmonitorcameraposition/getpeoplecountmonitorcameraposition"}],"panels":[]}]},"httpPath":"/people-count-monitor-camera-positions/{peopleCountMonitorCameraPositionId}"}],"content":{"contentType":"group","meta":{"name":"peopleCountMonitorCameraPosition"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"People Count Monitor Camera Positions","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an Organisation's people count monitor camera positions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/people-count-monitor-camera-positions","summary":"List people count monitor camera positions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/peoplecountmonitorcameraposition/listpeoplecountmonitorcamerapositions","deprecated":false},{"title":"/people-count-monitor-camera-positions","summary":"Create/Update people count monitor camera position","prefix":{"name":"put","color":"put"},"badges":[],"link":"/peoplecountmonitorcameraposition/putpeoplecountmonitorcameraposition","deprecated":false},{"title":"/people-count-monitor-camera-positions/{peopleCountMonitorCameraPositionId}","summary":"Delete people count monitor camera position","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/peoplecountmonitorcameraposition/deletepeoplecountmonitorcameraposition","deprecated":false},{"title":"/people-count-monitor-camera-positions/{peopleCountMonitorCameraPositionId}","summary":"Get people count monitor camera position","prefix":{"name":"get","color":"get"},"badges":[],"link":"/peoplecountmonitorcameraposition/getpeoplecountmonitorcameraposition","deprecated":false}]}]}]}]}},{"type":"separator","label":"PEEL-OFF MONITOR","content":null},{"type":"group","label":"Peel Off Monitors","link":"/v1/peeloffmonitor","routeSlug":"/v1/peeloffmonitor","items":[{"label":"List peel off monitors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peeloffmonitor/listpeeloffmonitors","routeSlug":"/v1/peeloffmonitor/listpeeloffmonitors","metadata":{"seo":{"title":"List peel off monitors","description":"Get all available peel off monitors subject to filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListPeelOffMonitors","name":"List peel off monitors","isWebhook":false,"pointer":"/paths/~1peel-off-monitors/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List peel off monitors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all available peel off monitors subject to filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"organisationId","in":"query","schemaId":"schema_48","description":"the ID of the associated organisation."},{"name":"siteId","in":"query","schemaId":"schema_48","description":"the ID of the site the peel off monitors are linked to."},{"name":"cameraPositionId","in":"query","schemaId":"schema_48","description":"the ID of a camera position linked to the peel off monitors."},{"name":"state","in":"query","schemaId":"schema_57","description":"Peel off monitors state."}],"pointer":"/paths/~1peel-off-monitors/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/peel-off-monitors","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"siteId","in":"query","schemaId":"schema_48"},{"name":"cameraPositionId","in":"query","schemaId":"schema_48"},{"name":"state","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500"],"pointer":"/peel-off-monitors","href":"peeloffmonitor/listpeeloffmonitors","openApiOperationId":"ListPeelOffMonitors","summary":"List peel off monitors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82"}},"schemaId":"schema_82"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1peel-off-monitors/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_82","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_82"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peeloffmonitor/listpeeloffmonitors"}],"panels":[]}]},"httpPath":"/peel-off-monitors"},{"label":"Create/Update peel off monitor","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peeloffmonitor/putpeeloffmonitor","routeSlug":"/v1/peeloffmonitor/putpeeloffmonitor","metadata":{"seo":{"title":"Create/Update peel off monitor","description":"Update a peel off monitor if it exists, create a new one otherwise."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutPeelOffMonitor","name":"Create/Update peel off monitor","isWebhook":false,"pointer":"/paths/~1peel-off-monitors/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create/Update peel off monitor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a peel off monitor if it exists, create a new one otherwise."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PeelOffMonitor"}},"schemaId":"components/schemas/PeelOffMonitor","pointer":"/paths/~1peel-off-monitors/put/requestBody","description":"A peel off monitor to put."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/peel-off-monitors","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PeelOffMonitor"}},"responseCodes":["201","204","400","401","403","410","422","500"],"pointer":"/peel-off-monitors","href":"peeloffmonitor/putpeeloffmonitor","openApiOperationId":"PutPeelOffMonitor","summary":"Create/Update peel off monitor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/PeelOffMonitor","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PeelOffMonitor"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeelOffMonitor"}},"schemaId":"components/schemas/PeelOffMonitor"},{"code":"204","description":"Updated."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1peel-off-monitors/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PeelOffMonitor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeelOffMonitor"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peeloffmonitor/putpeeloffmonitor"}],"panels":[]}]},"httpPath":"/peel-off-monitors"},{"label":"Delete peel off monitor","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peeloffmonitor/deletepeeloffmonitor","routeSlug":"/v1/peeloffmonitor/deletepeeloffmonitor","metadata":{"seo":{"title":"Delete peel off monitor","description":"Set the state of a peel off monitor to deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePeelOffMonitor","name":"Delete peel off monitor","isWebhook":false,"pointer":"/paths/~1peel-off-monitors~1{peelOffMonitorId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete peel off monitor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set the state of a peel off monitor to deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"peelOffMonitorId","in":"path","schemaId":"schema_48","description":"the ID of the peel off monitor to delete.","required":true}],"pointer":"/paths/~1peel-off-monitors~1{peelOffMonitorId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/peel-off-monitors/{peelOffMonitorId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"peelOffMonitorId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","410","422","500"],"pointer":"/peel-off-monitors/{peelOffMonitorId}","href":"peeloffmonitor/deletepeeloffmonitor","openApiOperationId":"DeletePeelOffMonitor","summary":"Delete peel off monitor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1peel-off-monitors~1{peelOffMonitorId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peeloffmonitor/deletepeeloffmonitor"}],"panels":[]}]},"httpPath":"/peel-off-monitors/{peelOffMonitorId}"},{"label":"Get peel off monitor","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peeloffmonitor/getpeeloffmonitor","routeSlug":"/v1/peeloffmonitor/getpeeloffmonitor","metadata":{"seo":{"title":"Get peel off monitor","description":"Get a peel off monitor identified by the provided ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPeelOffMonitor","name":"Get peel off monitor","isWebhook":false,"pointer":"/paths/~1peel-off-monitors~1{peelOffMonitorId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get peel off monitor","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a peel off monitor identified by the provided ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"peelOffMonitorId","in":"path","schemaId":"schema_48","description":"The ID of the peel off monitor.","required":true}],"pointer":"/paths/~1peel-off-monitors~1{peelOffMonitorId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/peel-off-monitors/{peelOffMonitorId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"peelOffMonitorId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","500"],"pointer":"/peel-off-monitors/{peelOffMonitorId}","href":"peeloffmonitor/getpeeloffmonitor","openApiOperationId":"GetPeelOffMonitor","summary":"Get peel off monitor"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeelOffMonitor"}},"schemaId":"components/schemas/PeelOffMonitor"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1peel-off-monitors~1{peelOffMonitorId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PeelOffMonitor","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeelOffMonitor"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peeloffmonitor/getpeeloffmonitor"}],"panels":[]}]},"httpPath":"/peel-off-monitors/{peelOffMonitorId}"}],"content":{"contentType":"group","meta":{"name":"peelOffMonitor"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Peel Off Monitors","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an Organisation's peel off monitors."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/peel-off-monitors","summary":"List peel off monitors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/peeloffmonitor/listpeeloffmonitors","deprecated":false},{"title":"/peel-off-monitors","summary":"Create/Update peel off monitor","prefix":{"name":"put","color":"put"},"badges":[],"link":"/peeloffmonitor/putpeeloffmonitor","deprecated":false},{"title":"/peel-off-monitors/{peelOffMonitorId}","summary":"Delete peel off monitor","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/peeloffmonitor/deletepeeloffmonitor","deprecated":false},{"title":"/peel-off-monitors/{peelOffMonitorId}","summary":"Get peel off monitor","prefix":{"name":"get","color":"get"},"badges":[],"link":"/peeloffmonitor/getpeeloffmonitor","deprecated":false}]}]}]}]}},{"type":"group","label":"Peel Off Monitor Camera Positions","link":"/v1/peeloffmonitorcameraposition","routeSlug":"/v1/peeloffmonitorcameraposition","items":[{"label":"List peel off monitor camera positions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peeloffmonitorcameraposition/listpeeloffmonitorcamerapositions","routeSlug":"/v1/peeloffmonitorcameraposition/listpeeloffmonitorcamerapositions","metadata":{"seo":{"title":"List peel off monitor camera positions","description":"Get all available peel off monitor camera positions subject to filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ListPeelOffMonitorCameraPositions","name":"List peel off monitor camera positions","isWebhook":false,"pointer":"/paths/~1peel-off-monitor-camera-positions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List peel off monitor camera positions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all available peel off monitor camera positions subject to filters."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"organisationId","in":"query","schemaId":"schema_48","description":"the ID of the associated organisation."},{"name":"siteId","in":"query","schemaId":"schema_48","description":"the ID of the site the peel off monitor camera positions are linked to."},{"name":"cameraPositionId","in":"query","schemaId":"schema_48","description":"the ID of a camera position linked to the peel off monitor camera positions."},{"name":"peelOffMonitorId","in":"query","schemaId":"schema_48","description":"the ID of the peel off monitor the peel off monitor camera position is linking."},{"name":"state","in":"query","schemaId":"schema_57","description":"Peel off monitor camera positions state filter."}],"pointer":"/paths/~1peel-off-monitor-camera-positions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/peel-off-monitor-camera-positions","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[{"name":"organisationId","in":"query","schemaId":"schema_48"},{"name":"siteId","in":"query","schemaId":"schema_48"},{"name":"cameraPositionId","in":"query","schemaId":"schema_48"},{"name":"peelOffMonitorId","in":"query","schemaId":"schema_48"},{"name":"state","in":"query","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","422","500"],"pointer":"/peel-off-monitor-camera-positions","href":"peeloffmonitorcameraposition/listpeeloffmonitorcamerapositions","openApiOperationId":"ListPeelOffMonitorCameraPositions","summary":"List peel off monitor camera positions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_83"}},"schemaId":"schema_83"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1peel-off-monitor-camera-positions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_83","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_83"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peeloffmonitorcameraposition/listpeeloffmonitorcamerapositions"}],"panels":[]}]},"httpPath":"/peel-off-monitor-camera-positions"},{"label":"Create/Update peel off monitor camera position","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peeloffmonitorcameraposition/putpeeloffmonitorcameraposition","routeSlug":"/v1/peeloffmonitorcameraposition/putpeeloffmonitorcameraposition","metadata":{"seo":{"title":"Create/Update peel off monitor camera position","description":"Update a peel off monitor's camera position if it exists, create a new object linking the given peel off monitor to the given camera position otherwise."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutPeelOffMonitorCameraPosition","name":"Create/Update peel off monitor camera position","isWebhook":false,"pointer":"/paths/~1peel-off-monitor-camera-positions/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create/Update peel off monitor camera position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update a peel off monitor's camera position if it exists, create a new\nobject linking the given peel off monitor to the given camera position otherwise."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PeelOffMonitorCameraPosition"}},"schemaId":"components/schemas/PeelOffMonitorCameraPosition","pointer":"/paths/~1peel-off-monitor-camera-positions/put/requestBody","description":"A peel off monitor camera position to put."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/peel-off-monitor-camera-positions","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PeelOffMonitorCameraPosition"}},"responseCodes":["201","204","400","401","403","410","422","500"],"pointer":"/peel-off-monitor-camera-positions","href":"peeloffmonitorcameraposition/putpeeloffmonitorcameraposition","openApiOperationId":"PutPeelOffMonitorCameraPosition","summary":"Create/Update peel off monitor camera position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"schemaId":"components/schemas/PeelOffMonitorCameraPosition","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PeelOffMonitorCameraPosition"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeelOffMonitorCameraPosition"}},"schemaId":"components/schemas/PeelOffMonitorCameraPosition"},{"code":"204","description":"Updated."},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1peel-off-monitor-camera-positions/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/PeelOffMonitorCameraPosition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeelOffMonitorCameraPosition"}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peeloffmonitorcameraposition/putpeeloffmonitorcameraposition"}],"panels":[]}]},"httpPath":"/peel-off-monitor-camera-positions"},{"label":"Delete peel off monitor camera position","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peeloffmonitorcameraposition/deletepeeloffmonitorcameraposition","routeSlug":"/v1/peeloffmonitorcameraposition/deletepeeloffmonitorcameraposition","metadata":{"seo":{"title":"Delete peel off monitor camera position","description":"Set the state of a peel off monitor camera position to deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeletePeelOffMonitorCameraPosition","name":"Delete peel off monitor camera position","isWebhook":false,"pointer":"/paths/~1peel-off-monitor-camera-positions~1{peelOffMonitorCameraPositionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete peel off monitor camera position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Set the state of a peel off monitor camera position to deleted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"peelOffMonitorCameraPositionId","in":"path","schemaId":"schema_48","description":"the ID of the peel off monitor camera position to delete.","required":true}],"pointer":"/paths/~1peel-off-monitor-camera-positions~1{peelOffMonitorCameraPositionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/peel-off-monitor-camera-positions/{peelOffMonitorCameraPositionId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"peelOffMonitorCameraPositionId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","401","403","404","410","422","500"],"pointer":"/peel-off-monitor-camera-positions/{peelOffMonitorCameraPositionId}","href":"peeloffmonitorcameraposition/deletepeeloffmonitorcameraposition","openApiOperationId":"DeletePeelOffMonitorCameraPosition","summary":"Delete peel off monitor camera position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"OK."},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"410","description":"Gone.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1peel-off-monitor-camera-positions~1{peelOffMonitorCameraPositionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"410","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peeloffmonitorcameraposition/deletepeeloffmonitorcameraposition"}],"panels":[]}]},"httpPath":"/peel-off-monitor-camera-positions/{peelOffMonitorCameraPositionId}"},{"label":"Get peel off monitor camera position","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/v1/peeloffmonitorcameraposition/getpeeloffmonitorcameraposition","routeSlug":"/v1/peeloffmonitorcameraposition/getpeeloffmonitorcameraposition","metadata":{"seo":{"title":"Get peel off monitor camera position","description":"Get a peel off monitor camera position identified by the provided ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GetPeelOffMonitorCameraPosition","name":"Get peel off monitor camera position","isWebhook":false,"pointer":"/paths/~1peel-off-monitor-camera-positions~1{peelOffMonitorCameraPositionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get peel off monitor camera position","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a peel off monitor camera position identified by the provided ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"api_key","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"peelOffMonitorCameraPositionId","in":"path","schemaId":"schema_48","description":"The ID of the peel off monitor camera position to get.","required":true}],"pointer":"/paths/~1peel-off-monitor-camera-positions~1{peelOffMonitorCameraPositionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/peel-off-monitor-camera-positions/{peelOffMonitorCameraPositionId}","servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"parameters":{"path":[{"name":"peelOffMonitorCameraPositionId","in":"path","required":true,"schemaId":"schema_48"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"api_key","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","401","403","404","422","500"],"pointer":"/peel-off-monitor-camera-positions/{peelOffMonitorCameraPositionId}","href":"peeloffmonitorcameraposition/getpeeloffmonitorcameraposition","openApiOperationId":"GetPeelOffMonitorCameraPosition","summary":"Get peel off monitor camera position"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/v1","description":"Mock server","isMockServer":true},{"url":"https://nexus.hoxton.ai/api/v1"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeelOffMonitorCameraPosition"}},"schemaId":"components/schemas/PeelOffMonitorCameraPosition"},{"code":"401","description":"Authentication failed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Not allowed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"404","description":"Not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"422","description":"Unprocessable entity.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"500","description":"Failed."}],"pointer":"/paths/~1peel-off-monitor-camera-positions~1{peelOffMonitorCameraPositionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PeelOffMonitorCameraPosition","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PeelOffMonitorCameraPosition"}}},{"code":"401","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"422","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/peeloffmonitorcameraposition/getpeeloffmonitorcameraposition"}],"panels":[]}]},"httpPath":"/peel-off-monitor-camera-positions/{peelOffMonitorCameraPositionId}"}],"content":{"contentType":"group","meta":{"name":"peelOffMonitorCameraPosition"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Peel Off Monitor Camera Positions","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage an Organisation's peel off monitor camera positions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/peel-off-monitor-camera-positions","summary":"List peel off monitor camera positions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/peeloffmonitorcameraposition/listpeeloffmonitorcamerapositions","deprecated":false},{"title":"/peel-off-monitor-camera-positions","summary":"Create/Update peel off monitor camera position","prefix":{"name":"put","color":"put"},"badges":[],"link":"/peeloffmonitorcameraposition/putpeeloffmonitorcameraposition","deprecated":false},{"title":"/peel-off-monitor-camera-positions/{peelOffMonitorCameraPositionId}","summary":"Delete peel off monitor camera position","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/peeloffmonitorcameraposition/deletepeeloffmonitorcameraposition","deprecated":false},{"title":"/peel-off-monitor-camera-positions/{peelOffMonitorCameraPositionId}","summary":"Get peel off monitor camera position","prefix":{"name":"get","color":"get"},"badges":[],"link":"/peeloffmonitorcameraposition/getpeeloffmonitorcameraposition","deprecated":false}]}]}]}]}},{"type":"separator","label":"TalkBack","content":null},{"type":"group","label":"TalkBack","link":"/v1/talkback","routeSlug":"/v1/talkback","items":[],"content":{"contentType":"group","meta":{"name":"talkBack"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TalkBack","showPageActions":true},{"nodeType":"markdoc","content":"APIs to manage talkbacks devices and reports."}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/talkback"}],"panels":[]}]}}],"store":{"schemaStore":{"components/schemas/AggregatedApiRequestMetrics":{"id":"components/schemas/AggregatedApiRequestMetrics","kind":"json-schema","title":"AggregatedApiRequestMetrics","data":{"properties":{"clientID":{"readOnly":true,"type":"string"},"dailyAPICallCount":{"readOnly":true,"type":"integer","nullable":true},"dailyActiveUser":{"readOnly":true,"type":"integer","nullable":true},"organisationID":{"format":"uuid","readOnly":true,"type":"string"},"time":{"format":"date-time","readOnly":true,"type":"string"}}}},"components/schemas/AggregatedApiRequestMetricsReport":{"id":"components/schemas/AggregatedApiRequestMetricsReport","kind":"json-schema","title":"AggregatedApiRequestMetricsReport","data":{"properties":{"clientIds":{"description":"A list of IDs of the clients to fetch the data for.","items":{"type":"string"},"type":"array"},"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the upper bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is non-inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]}]}]}],"format":"date","type":"string"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the lower bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]}]}]}],"format":"date","type":"string"}},"type":"object"}},"components/schemas/AggregatedVideoMetrics":{"id":"components/schemas/AggregatedVideoMetrics","kind":"json-schema","title":"AggregatedVideoMetrics","data":{"properties":{"cameraId":{"format":"uuid","readOnly":true,"type":"string"},"lateCount":{"readOnly":true,"type":"integer","nullable":true},"missingCount":{"readOnly":true,"type":"integer","nullable":true},"onTimeCount":{"readOnly":true,"type":"integer","nullable":true},"time":{"format":"date-time","readOnly":true,"type":"string"}}}},"components/schemas/AggregatedVideoMetricsReport":{"id":"components/schemas/AggregatedVideoMetricsReport","kind":"json-schema","title":"AggregatedVideoMetricsReport","data":{"properties":{"cameraIds":{"description":"A list of IDs of the cameras to fetch the data for.","items":{"format":"uuid","type":"string"},"type":"array"},"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the upper bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is non-inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]}]}]}],"format":"date","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the lower bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]}]}]}],"format":"date","type":"string"},"timeGrain":{"default":"24h","description":"The time granularity of the response.","enum":["1h","24h","168h"],"type":"string"}},"type":"object"}},"components/schemas/Alert":{"id":"components/schemas/Alert","kind":"json-schema","title":"Alert","data":{"properties":{"alertScope":{"description":"The scope level of the alert.","enum":["mixed","organisation","resource","site"],"readOnly":true,"type":"string"},"alertType":{"enum":["offline_alert","occupancy_alert","camera_health_summary_alert","people_count"],"type":"string"},"configurationDetails":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type-specific alert configuration; its shape depends on alertType. For occupancy_alert see OccupancyAlertConfiguration. Validated server-side rather than by this (Swagger 2.0) schema."},"children":[]}]}]}],"type":"object"},"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"deletedAt":{"format":"date-time","readOnly":true,"type":"string","nullable":true},"emails":{"items":{"format":"email","type":"string"},"minItems":1,"type":"array","x-omitempty":true,"nullable":true},"id":{"format":"uuid","type":"string","nullable":true},"name":{"type":"string"},"organisationId":{"format":"uuid","type":"string"},"state":{"enum":["active","deleted"],"type":"string"},"webhook":{"type":"object"}},"required":["organisationId","alertType","name"],"type":"object"}},"components/schemas/AlertCameraPosition":{"id":"components/schemas/AlertCameraPosition","kind":"json-schema","title":"AlertCameraPosition","data":{"properties":{"alertId":{"format":"uuid","type":"string"},"cameraPositionId":{"format":"uuid","type":"string"}},"required":["alertId","cameraPositionId"],"type":"object"}},"components/schemas/AlertNotificationGroup":{"id":"components/schemas/AlertNotificationGroup","kind":"json-schema","title":"AlertNotificationGroup","data":{"properties":{"alertId":{"format":"uuid","type":"string"},"notificationGroupId":{"format":"uuid","type":"string"}},"required":["alertId","notificationGroupId"],"type":"object"}},"components/schemas/AlertOccupancyMonitor":{"id":"components/schemas/AlertOccupancyMonitor","kind":"json-schema","title":"AlertOccupancyMonitor","data":{"properties":{"alertId":{"format":"uuid","type":"string"},"occupancyMonitorId":{"format":"uuid","type":"string"}},"required":["alertId","occupancyMonitorId"],"type":"object"}},"components/schemas/AlertPeopleCountMonitor":{"id":"components/schemas/AlertPeopleCountMonitor","kind":"json-schema","title":"AlertPeopleCountMonitor","data":{"properties":{"alertId":{"format":"uuid","type":"string"},"peopleCountMonitorId":{"format":"uuid","type":"string"}},"required":["alertId","peopleCountMonitorId"],"type":"object"}},"components/schemas/AlertSite":{"id":"components/schemas/AlertSite","kind":"json-schema","title":"AlertSite","data":{"properties":{"alertId":{"format":"uuid","type":"string"},"siteId":{"format":"uuid","type":"string"}},"required":["alertId","siteId"],"type":"object"}},"components/schemas/Annotation":{"id":"components/schemas/Annotation","kind":"json-schema","title":"Annotation","data":{"properties":{"cameraPositionId":{"format":"uuid","type":"string"},"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"deletedAt":{"format":"date-time","readOnly":true,"type":"string","nullable":true},"id":{"format":"uuid","type":"string","nullable":true},"kind":{"enum":["polygon","multipolygon"],"type":"string"},"roi":{"type":"object","x-go-type":{"hints":{"kind":"interface"},"import":{"package":"github.com/paulmach/orb/geojson"},"type":"FeatureCollection"},"nullable":true},"state":{"enum":["active","deleted"],"type":"string"}},"required":["cameraPositionId","roi"],"type":"object"}},"components/schemas/ApiKeyCreated":{"id":"components/schemas/ApiKeyCreated","kind":"json-schema","title":"ApiKeyCreated","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response returned when a new API key is created. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apiKey"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is shown only once."},"children":[]}]}]}],"properties":{"apiKey":{"description":"The full API key, sent as a bearer token in the Authorization header. Returned once at creation and never again.","readOnly":true,"type":"string"},"apiKeyId":{"format":"uuid","readOnly":true,"type":"string"},"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"expiresAt":{"format":"date-time","type":"string","nullable":true},"name":{"type":"string"},"organisationId":{"format":"uuid","readOnly":true,"type":"string"},"prefix":{"description":"Public identifier embedded in the API key; also shown in the UI.","readOnly":true,"type":"string"},"role":{"description":"The role whose permissions the key is granted.","type":"string"},"siteIds":{"description":"Sites the key is scoped to. Populated for member and analyst keys; empty for admin and manager keys.","items":{"format":"uuid","type":"string"},"readOnly":true,"type":"array"}},"required":["apiKeyId","name","prefix","apiKey","organisationId","role"]}},"components/schemas/ApiKeyLink":{"id":"components/schemas/ApiKeyLink","kind":"json-schema","title":"ApiKeyLink","data":{"description":"API key metadata. Secrets are never included.","properties":{"apiKeyId":{"format":"uuid","readOnly":true,"type":"string"},"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"createdBy":{"readOnly":true,"type":"string"},"expiresAt":{"format":"date-time","type":"string","nullable":true},"lastUsedAt":{"format":"date-time","readOnly":true,"type":"string","nullable":true},"name":{"type":"string"},"organisationId":{"format":"uuid","readOnly":true,"type":"string"},"prefix":{"readOnly":true,"type":"string"},"revokedAt":{"format":"date-time","readOnly":true,"type":"string","nullable":true},"role":{"description":"The role whose permissions the key is granted.","readOnly":true,"type":"string"},"siteIds":{"description":"Sites the key is scoped to. Populated for member and analyst keys; empty for admin and manager keys.","items":{"format":"uuid","type":"string"},"readOnly":true,"type":"array"}},"required":["apiKeyId","name","prefix","organisationId"]}},"components/schemas/Camera":{"id":"components/schemas/Camera","kind":"json-schema","title":"Camera","data":{"properties":{"cameraPositionId":{"format":"uuid","type":"string"},"cameraStatus":{"enum":["offline","online","not_recording","lagging","not_uploading"],"readOnly":true,"type":"string","nullable":true},"claimedAt":{"format":"date-time","type":"string"},"direction1Alias":{"type":"string"},"direction2Alias":{"type":"string"},"encodedFramesProportion":{"description":"The number of frames encoded over the expected number of frames in the last 2 minutes.","format":"float64","minimum":0,"readOnly":true,"type":"number","nullable":true},"id":{"format":"uuid","type":"string"},"isOnline":{"type":"boolean","nullable":true},"lastSeenAt":{"format":"date-time","type":"string","nullable":true},"lastVideoAt":{"format":"date-time","readOnly":true,"type":"string","nullable":true},"name":{"type":"string"},"networkTransmitRate":{"description":"The rate in bytes/second the camera sends information over the network at.","format":"uint64","minimum":0,"readOnly":true,"type":"number","nullable":true},"organisationId":{"format":"uuid","readOnly":true,"type":"string"},"serialNumber":{"readOnly":true,"type":"string"},"siteId":{"format":"uuid","type":"string"},"state":{"enum":["running","decommissioned","paused"],"type":"string"},"videoBacklog":{"description":"The number of milliseconds of video the camera is waiting to upload.","format":"uint64","minimum":0,"type":"number","nullable":true},"videoUploadLatency":{"description":"The number of milliseconds it took the latest video uploaded to be uploaded.","minimum":0,"readOnly":true,"type":"number","nullable":true}},"type":"object"}},"components/schemas/CameraPositionPeopleCount":{"id":"components/schemas/CameraPositionPeopleCount","kind":"json-schema","title":"CameraPositionPeopleCount","data":{"properties":{"cameraName":{"readOnly":true,"type":"string"},"cameraPositionId":{"format":"uuid","readOnly":true,"type":"string"},"direction1Alias":{"readOnly":true,"type":"string"},"direction1Count":{"readOnly":true,"type":"integer","nullable":true},"direction2Alias":{"readOnly":true,"type":"string"},"direction2Count":{"readOnly":true,"type":"integer","nullable":true},"time":{"format":"date-time","readOnly":true,"type":"string"}},"type":"object"}},"components/schemas/CameraPositionPeopleCountReport":{"id":"components/schemas/CameraPositionPeopleCountReport","kind":"json-schema","title":"CameraPositionPeopleCountReport","data":{"properties":{"cameraPositionIds":{"items":{"format":"uuid","type":"string"},"type":"array"},"endDate":{"description":"The upper bound of the date range (non-inclusive).","format":"date","type":"string"},"isOpen":{"default":false,"description":"Flag to filter output within site opening hour window","type":"boolean"},"startDate":{"description":"The lower bound of the date range (inclusive).","format":"date","type":"string"},"timeGrain":{"default":"1h","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time window for data aggregation. Time grains below "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are only available for the most recent 6 months of data. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is more than 6 months in the past only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are accepted; such requests are served from hourly rollups which may exclude the most recent day."},"children":[]}]}]}],"enum":["1s","1m","5m","15m","30m","1h","6h","24h"],"type":"string"}},"required":["cameraPositionIds","endDate","startDate"],"type":"object"}},"components/schemas/DwellTimeData":{"id":"components/schemas/DwellTimeData","kind":"json-schema","title":"DwellTimeData","data":{"properties":{"day":{"type":"string"},"description":{"type":"string"},"dwellTime":{"type":"string"},"monitorType":{"type":"string"}},"type":"object"}},"components/schemas/DwellTimeReportRequest":{"id":"components/schemas/DwellTimeReportRequest","kind":"json-schema","title":"DwellTimeReportRequest","data":{"properties":{"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the upper bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is non-inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]}]}]}],"format":"date","type":"string"},"occupancyMonitorIds":{"description":"List of occupancy monitor ids in the report.","items":{"format":"uuid","type":"string"},"type":"array"},"organisationId":{"format":"uuid","type":"string"},"peopleCountMonitorIds":{"description":"List of people count monitor ids in the report.","items":{"format":"uuid","type":"string"},"type":"array"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the lower bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Dwell time reports are only available for the most recent 6 months of data; a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" more than 6 months in the past is rejected."},"children":[]}]}]}],"format":"date","type":"string"}},"required":["endDate","organisationId","startDate"],"type":"object"}},"components/schemas/DwellTimeRequestResponse":{"id":"components/schemas/DwellTimeRequestResponse","kind":"json-schema","title":"DwellTimeRequestResponse","data":{"properties":{"createdAt":{"format":"datetime","type":"string"},"dwellTimeReportId":{"format":"uuid","type":"string"},"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the upper bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is non-inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]}]}]}],"format":"date","type":"string"},"errorMessage":{"description":"error in dwell time report.","type":"string"},"occupancyMonitorIds":{"description":"List of occupancy monitor ids in the report.","items":{"format":"uuid","type":"string"},"type":"array"},"organisationId":{"format":"uuid","type":"string"},"peopleCountMonitorIds":{"description":"List of people count monitor ids in the report.","items":{"format":"uuid","type":"string"},"type":"array"},"reportData":{"items":{"$ref":"#/components/schemas/DwellTimeData"},"type":"array"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the lower bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]}]}]}],"format":"date","type":"string"},"status":{"enum":["completed","completed_with_errors","pending"],"type":"string"}},"type":"object"}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}},"components/schemas/Frame":{"id":"components/schemas/Frame","kind":"json-schema","title":"Frame","data":{"properties":{"image":{"type":"string"},"timestamp":{"format":"date-time","type":"string"}},"type":"object"}},"components/schemas/FrameRequest":{"id":"components/schemas/FrameRequest","kind":"json-schema","title":"FrameRequest","data":{"properties":{"cameraId":{"format":"uuid","type":"string"}},"required":["cameraId"],"type":"object"}},"components/schemas/Job":{"id":"components/schemas/Job","kind":"json-schema","title":"Job","data":{"properties":{"id":{"format":"uuid","readOnly":true,"type":"string"},"msg":{"type":"string"},"status":{"enum":["created","failed","success"],"type":"string"}},"required":["id","status","msg"]}},"components/schemas/LiveOccupancy":{"id":"components/schemas/LiveOccupancy","kind":"json-schema","title":"LiveOccupancy","data":{"properties":{"occupancy":{"readOnly":true,"type":"integer"},"occupancyMonitorId":{"format":"uuid","readOnly":true,"type":"string"},"time":{"format":"date-time","readOnly":true,"type":"string"}}}},"components/schemas/LiveOccupancyReport":{"id":"components/schemas/LiveOccupancyReport","kind":"json-schema","title":"LiveOccupancyReport","data":{"properties":{"occupancyMonitorIds":{"description":"List of occupancy monitor ids in the report.","items":{"format":"uuid","type":"string"},"type":"array","nullable":true},"organisationIds":{"description":"List of organisation ids in the report.","items":{"format":"uuid","type":"string"},"type":"array","nullable":true},"siteIds":{"description":"List of site ids in the report.","items":{"format":"uuid","type":"string"},"type":"array","nullable":true}}}},"components/schemas/MetricPoint":{"id":"components/schemas/MetricPoint","kind":"json-schema","title":"MetricPoint","data":{"properties":{"intervalEnd":{"description":"intervalEnd is the end of the time interval in which the measurement was taken.","format":"date-time","type":"string"},"intervalStart":{"description":"intervalStart is the start of the time interval in which the measurement was taken.","format":"date-time","type":"string"},"value":{"description":"the value of the measurement for the given interval.","type":"number"}},"required":["intervalEnd","intervalStart","value"]}},"components/schemas/NotificationGroup":{"id":"components/schemas/NotificationGroup","kind":"json-schema","title":"NotificationGroup","data":{"properties":{"deletedAt":{"format":"date-time","readOnly":true,"type":"string","nullable":true},"emails":{"items":{"format":"email","type":"string"},"type":"array"},"id":{"format":"uuid","type":"string","nullable":true},"name":{"type":"string"},"organisationId":{"format":"uuid","type":"string"},"state":{"enum":["active","deleted"],"type":"string"},"webhook":{"type":"object"}},"required":["name","organisationId"],"type":"object"}},"components/schemas/NotificationGroupNotificationGroup":{"id":"components/schemas/NotificationGroupNotificationGroup","kind":"json-schema","title":"NotificationGroupNotificationGroup","data":{"properties":{"childId":{"format":"uuid","type":"string"},"deletedAt":{"format":"date-time","readOnly":true,"type":"string","nullable":true},"id":{"format":"uuid","type":"string","nullable":true},"organisationId":{"format":"uuid","type":"string"},"parentId":{"format":"uuid","type":"string"},"state":{"enum":["active","deleted"],"type":"string"}},"required":["organisationId","childId","parentId"],"type":"object"}},"components/schemas/Occupancy":{"id":"components/schemas/Occupancy","kind":"json-schema","title":"Occupancy","data":{"properties":{"inCountSum":{"readOnly":true,"type":"integer","nullable":true},"occupancyAvg":{"readOnly":true,"type":"integer","nullable":true},"occupancyMax":{"readOnly":true,"type":"integer","nullable":true},"occupancyMonitorId":{"format":"uuid","readOnly":true,"type":"string"},"outCountSum":{"readOnly":true,"type":"integer","nullable":true},"time":{"format":"date-time","readOnly":true,"type":"string"}}}},"components/schemas/OccupancyAlertConfiguration":{"id":"components/schemas/OccupancyAlertConfiguration","kind":"json-schema","title":"OccupancyAlertConfiguration","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configuration for an occupancy alert (alertType occupancy_alert), supplied as the Alert.configurationDetails object. Thresholds are fractions of the monitor's capacity (e.g. 0.89 means 89%). Bands are ordered warningRecoveryThreshold < warningThreshold < alertRecoveryThreshold <= alertThreshold. When notifyAlertRecovery is false, alertRecoveryThreshold is unused and warningThreshold need only sit below alertThreshold. These rules are enforced server-side; Swagger 2.0 cannot express the conditional requirement declaratively."},"children":[]}]}]}],"properties":{"alertRecoveryThreshold":{"description":"Fraction of capacity below which the alert clears. Greater than 0 and less than or equal to alertThreshold. Required only when notifyAlertRecovery is true; ignored otherwise.","exclusiveMinimum":true,"format":"double","minimum":0,"type":"number"},"alertThreshold":{"description":"Fraction of capacity at or above which the alert fires.","exclusiveMinimum":true,"format":"double","minimum":0,"type":"number"},"duration":{"description":"Dwell time the breach must persist before alerting, as a Go duration string (e.g. 15m). Defaults to 15m.","type":"string"},"notifyAlert":{"description":"Whether to notify when the alert threshold is breached. Defaults to true.","type":"boolean"},"notifyAlertRecovery":{"description":"Whether to notify when occupancy recovers below alertRecoveryThreshold. Defaults to false.","type":"boolean"},"notifyWarning":{"description":"Whether to notify when the warning threshold is breached. Defaults to false.","type":"boolean"},"notifyWarningRecovery":{"description":"Whether to notify when occupancy recovers below warningRecoveryThreshold. Defaults to false.","type":"boolean"},"recoveryNotifyDelay":{"description":"Delay before a recovery notification is sent, as a Go duration string (e.g. 15m). Defaults to 15m.","type":"string"},"warningRecoveryThreshold":{"description":"Fraction of capacity below which a warning clears. Less than warningThreshold. Required when warningThreshold is set.","exclusiveMinimum":true,"format":"double","minimum":0,"type":"number"},"warningThreshold":{"description":"Fraction of capacity at or above which a warning is raised. Below alertRecoveryThreshold (or alertThreshold when notifyAlertRecovery is false). Enables warning notifications when set.","exclusiveMinimum":true,"format":"double","minimum":0,"type":"number"}},"required":["alertThreshold"],"type":"object"}},"components/schemas/OccupancyMonitor":{"id":"components/schemas/OccupancyMonitor","kind":"json-schema","title":"OccupancyMonitor","data":{"properties":{"capacity":{"example":100,"format":"uint64","minimum":1,"type":"integer","nullable":true},"dailyResetTime":{"default":"00:00","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","type":"string"},"deletedAt":{"format":"date-time","readOnly":true,"type":"string","nullable":true},"id":{"format":"uuid","type":"string","nullable":true},"name":{"type":"string"},"openingHour":{"type":"object","x-go-type":{"hints":{"kind":"interface","noValidation":true},"type":"hoxton.DayOpeningHour"},"nullable":true},"reportingEndDate":{"format":"date","type":"string","nullable":true},"reportingStartDate":{"format":"date","type":"string","nullable":true},"siteId":{"format":"uuid","type":"string"},"state":{"enum":["active","deleted"],"type":"string"}},"required":["dailyResetTime","name","siteId"],"type":"object"}},"components/schemas/OccupancyMonitorCameraPosition":{"id":"components/schemas/OccupancyMonitorCameraPosition","kind":"json-schema","title":"OccupancyMonitorCameraPosition","data":{"properties":{"cameraPositionId":{"format":"uuid","type":"string"},"deletedAt":{"format":"date-time","readOnly":true,"type":"string","nullable":true},"id":{"format":"uuid","type":"string","nullable":true},"inDirection":{"enum":["direction_1","direction_2"],"type":"string"},"occupancyMonitorId":{"format":"uuid","type":"string"},"state":{"enum":["active","deleted"],"type":"string"}},"required":["cameraPositionId","inDirection","occupancyMonitorId"],"type":"object"}},"components/schemas/OccupancyReport":{"id":"components/schemas/OccupancyReport","kind":"json-schema","title":"OccupancyReport","data":{"properties":{"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the upper bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is non-inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"id":{"format":"uuid","readOnly":true,"type":"string"},"isOpen":{"default":false,"description":"Flag to filter output within site opening hour window","type":"boolean"},"limit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of rows of returned data. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value returns all rows in the requested time range."},"children":[]}]}]}],"type":"integer"},"metrics":{"description":"List of metrics associated with the monitors.","items":{"enum":["occupancy_avg","occupancy_max","in_count_sum","out_count_sum"],"type":"string"},"type":"array"},"occupancyMonitorIds":{"description":"List of occupancy monitor ids in the report. At least one id is required.","items":{"format":"uuid","type":"string"},"type":"array"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the lower bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"timeGrain":{"default":"1m","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time window in the requested range for data aggregation. Time grains below "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are only available for the most recent 6 months of data. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is more than 6 months in the past only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are accepted; such requests are served from hourly rollups which may exclude the most recent day."},"children":[]}]}]}],"enum":["1m","5m","15m","30m","1h","6h","24h"],"type":"string"}},"type":"object"}},"components/schemas/Organisation":{"id":"components/schemas/Organisation","kind":"json-schema","title":"Organisation","data":{"properties":{"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"id":{"format":"uuid","type":"string"},"licence":{"items":{"enum":["data_explorer","occupancy_monitor","people_count","real_time","dwell_time"],"type":"string"},"type":"array"},"maxAdminSeats":{"format":"uint64","minimum":0,"type":"integer","nullable":true},"maxUserSeats":{"format":"uint64","minimum":0,"type":"integer","nullable":true},"name":{"type":"string"},"processingGroup":{"format":"int64","minimum":0,"type":"integer","nullable":true},"state":{"enum":["active","churned","disabled"],"type":"string"}},"type":"object"}},"components/schemas/PatchCameraRequest":{"id":"components/schemas/PatchCameraRequest","kind":"json-schema","title":"PatchCameraRequest","data":{"properties":{"direction1Alias":{"type":"string"},"direction2Alias":{"type":"string"},"name":{"type":"string"}},"type":"object"}},"components/schemas/PatchDwellTimeReportRequest":{"id":"components/schemas/PatchDwellTimeReportRequest","kind":"json-schema","title":"PatchDwellTimeReportRequest","data":{"properties":{"errorMessage":{"type":"string"},"reportData":{"items":{"$ref":"#/components/schemas/DwellTimeData"},"type":"array"},"status":{"enum":["awaiting_approval","pending"],"type":"string"}},"type":"object"}},"components/schemas/PeelOffData":{"id":"components/schemas/PeelOffData","kind":"json-schema","title":"PeelOffData","data":{"properties":{"base":{"readOnly":true,"type":"integer","nullable":true},"id":{"format":"uuid","readOnly":true,"type":"string"},"name":{"readOnly":true,"type":"string"},"peelOff":{"readOnly":true,"type":"integer","nullable":true},"rate":{"format":"float64","readOnly":true,"type":"number","nullable":true},"time":{"format":"date-time","readOnly":true,"type":"string"}}}},"components/schemas/PeelOffMonitor":{"id":"components/schemas/PeelOffMonitor","kind":"json-schema","title":"PeelOffMonitor","data":{"properties":{"deletedAt":{"format":"date-time","readOnly":true,"type":"string","nullable":true},"id":{"format":"uuid","type":"string","nullable":true},"name":{"type":"string"},"openingHour":{"type":"object","x-go-type":{"hints":{"kind":"interface","noValidation":true},"type":"hoxton.DayOpeningHour"},"nullable":true},"reportingEndDate":{"format":"date","type":"string","nullable":true},"reportingStartDate":{"format":"date","type":"string","nullable":true},"siteId":{"format":"uuid","type":"string"},"state":{"enum":["active","deleted"],"type":"string"}},"required":["siteId"],"type":"object"}},"components/schemas/PeelOffMonitorCameraPosition":{"id":"components/schemas/PeelOffMonitorCameraPosition","kind":"json-schema","title":"PeelOffMonitorCameraPosition","data":{"properties":{"cameraPositionId":{"format":"uuid","type":"string"},"countDirection":{"enum":["direction_1","direction_2","direction_both"],"type":"string"},"countType":{"enum":["base","peel_off"],"type":"string"},"deletedAt":{"format":"date-time","readOnly":true,"type":"string","nullable":true},"id":{"format":"uuid","type":"string","nullable":true},"peelOffMonitorId":{"format":"uuid","type":"string"},"state":{"enum":["active","deleted"],"type":"string"}},"required":["cameraPositionId","countDirection","countType","peelOffMonitorId"],"type":"object"}},"components/schemas/PeelOffReport":{"id":"components/schemas/PeelOffReport","kind":"json-schema","title":"PeelOffReport","data":{"properties":{"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the upper bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is non-inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If provided will take precedence over endAt."},"children":[]}]}]}],"format":"date","type":"string"},"isOpen":{"default":false,"description":"Flag to filter output within site opening hour window","type":"boolean"},"peelOffMonitorIds":{"description":"List of peel off monitor ids in the report. At least one id is required.","items":{"format":"uuid","type":"string"},"type":"array"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the lower bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"timeGrain":{"default":"1h","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time window in the requested range to for data aggregation. Time grains below "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are only available for the most recent 6 months of data. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is more than 6 months in the past only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are accepted; such requests are served from hourly rollups which may exclude the most recent day."},"children":[]}]}]}],"enum":["1s","1m","5m","15m","30m","1h","6h","24h"],"type":"string"}},"type":"object"}},"components/schemas/PeopleCount":{"id":"components/schemas/PeopleCount","kind":"json-schema","title":"PeopleCount","data":{"properties":{"direction1Alias":{"readOnly":true,"type":"string"},"direction1Count":{"readOnly":true,"type":"integer","nullable":true},"direction2Alias":{"readOnly":true,"type":"string"},"direction2Count":{"readOnly":true,"type":"integer","nullable":true},"monitorName":{"readOnly":true,"type":"string"},"peopleCountMonitorId":{"format":"uuid","readOnly":true,"type":"string"},"time":{"format":"date-time","readOnly":true,"type":"string"}}}},"components/schemas/PeopleCountMonitor":{"id":"components/schemas/PeopleCountMonitor","kind":"json-schema","title":"PeopleCountMonitor","data":{"properties":{"dailyResetTime":{"default":"00:00","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$","type":"string","nullable":true},"deletedAt":{"format":"date-time","readOnly":true,"type":"string","nullable":true},"direction1Alias":{"type":"string"},"direction2Alias":{"type":"string"},"id":{"format":"uuid","type":"string","nullable":true},"name":{"type":"string"},"openingHour":{"type":"object","x-go-type":{"hints":{"kind":"interface","noValidation":true},"type":"hoxton.DayOpeningHour"},"nullable":true},"reportingEndDate":{"format":"date","type":"string","nullable":true},"reportingStartDate":{"format":"date","type":"string","nullable":true},"siteId":{"format":"uuid","type":"string"},"state":{"enum":["active","deleted"],"type":"string"}},"required":["siteId"],"type":"object"}},"components/schemas/PeopleCountMonitorCameraPosition":{"id":"components/schemas/PeopleCountMonitorCameraPosition","kind":"json-schema","title":"PeopleCountMonitorCameraPosition","data":{"properties":{"cameraPositionId":{"format":"uuid","type":"string"},"deletedAt":{"format":"date-time","readOnly":true,"type":"string","nullable":true},"direction1":{"enum":["direction_1","direction_2"],"type":"string"},"id":{"format":"uuid","type":"string","nullable":true},"peopleCountMonitorId":{"format":"uuid","type":"string"},"state":{"enum":["active","deleted"],"type":"string"}},"required":["cameraPositionId","direction1","peopleCountMonitorId"],"type":"object"}},"components/schemas/PeopleCountReport":{"id":"components/schemas/PeopleCountReport","kind":"json-schema","title":"PeopleCountReport","data":{"properties":{"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the upper bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is non-inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"isOpen":{"default":false,"description":"Flag to filter output within site opening hour window","type":"boolean"},"peopleCountMonitorIds":{"description":"List of people count monitor ids in the report. At least one id is required.","items":{"format":"uuid","type":"string"},"type":"array"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the lower bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date","type":"string"},"timeGrain":{"default":"1h","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time window in the requested range to for data aggregation. Time grains below "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are only available for the most recent 6 months of data. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is more than 6 months in the past only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24h"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are accepted; such requests are served from hourly rollups which may exclude the most recent day."},"children":[]}]}]}],"enum":["1s","1m","5m","15m","30m","1h","6h","24h"],"type":"string"}},"type":"object"}},"components/schemas/PutDwellTimeReportRequest":{"id":"components/schemas/PutDwellTimeReportRequest","kind":"json-schema","title":"PutDwellTimeReportRequest","data":{"properties":{"approvedBy":{"description":"approver of dwell time report","type":"string"},"errorMessage":{"description":"error message if rejected","type":"string"},"status":{"description":"The status of a dwell time.","enum":["approved","rejected"],"type":"string"}},"required":["approvedBy","status"]}},"components/schemas/ReportFilter":{"id":"components/schemas/ReportFilter","kind":"json-schema","title":"ReportFilter","data":{"properties":{"cameraIds":{"description":"A list of IDs of the cameras to fetch the data for.","items":{"format":"uuid","type":"string"},"type":"array"},"endAt":{"description":"The non-inclusive upper bound of the time range for which to return data.","format":"date-time","type":"string"},"format":{"default":"csv","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format of returned data. Should be either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"startAt":{"description":"The include lower bound of the time range for which to return data.","format":"date-time","type":"string"},"timeGrain":{"default":"1h","description":"The time window in the requested range to for data aggregation.","enum":["1m","5m","15m","30m","1h","6h","1d"],"type":"string"}},"type":"object"}},"components/schemas/Site":{"id":"components/schemas/Site","kind":"json-schema","title":"Site","data":{"properties":{"address":{"type":"string"},"id":{"format":"uuid","type":"string","nullable":true},"name":{"minLength":1,"type":"string"},"openingHour":{"type":"object","x-go-type":{"hints":{"kind":"interface","noValidation":true},"type":"hoxton.DayOpeningHour"},"nullable":true},"organisationId":{"format":"uuid","type":"string"},"state":{"enum":["active","deleted"],"type":"string"},"tz":{"type":"string"}},"required":["name"],"type":"object"}},"components/schemas/TSAnalyticsMetadataResponse":{"id":"components/schemas/TSAnalyticsMetadataResponse","kind":"json-schema","title":"TSAnalyticsMetadataResponse","data":{"properties":{"tables":{"items":{"$ref":"#/components/schemas/TSAnalyticsTableMetadata"},"readOnly":true,"type":"array"}},"type":"object"}},"components/schemas/TSAnalyticsRecord":{"id":"components/schemas/TSAnalyticsRecord","kind":"json-schema","title":"TSAnalyticsRecord","data":{"properties":{"eventTime":{"format":"date-time","readOnly":true,"type":"string"},"metricLabel":{"readOnly":true,"type":"string"},"metricLabelGroup":{"readOnly":true,"type":"string"},"metricName":{"readOnly":true,"type":"string"},"metricType":{"readOnly":true,"type":"string"},"metricValue":{"format":"double","readOnly":true,"type":"number","nullable":true},"metricValueAvg":{"format":"double","readOnly":true,"type":"number","nullable":true},"metricValueMax":{"format":"double","readOnly":true,"type":"number","nullable":true},"metricValueSum":{"format":"double","readOnly":true,"type":"number","nullable":true},"site":{"readOnly":true,"type":"string"}},"type":"object"}},"components/schemas/TSAnalyticsReportRequest":{"id":"components/schemas/TSAnalyticsReportRequest","kind":"json-schema","title":"TSAnalyticsReportRequest","data":{"properties":{"endDate":{"description":"Upper bound of the date range (non-inclusive).","format":"date-time","type":"string"},"limit":{"default":1000,"description":"Maximum number of records to return.","maximum":10000,"minimum":1,"type":"integer"},"metricLabelGroups":{"description":"Filter by metric label groups.","items":{"type":"string"},"type":"array"},"metricLabels":{"description":"Filter by metric labels.","items":{"type":"string"},"type":"array"},"metricNames":{"description":"Filter by metric names.","items":{"type":"string"},"type":"array"},"offset":{"default":0,"description":"Number of records to skip for pagination.","minimum":0,"type":"integer"},"organisationId":{"description":"Scope the report to a specific organisation. Only honoured for callers\nwith read:report:all (support); ignored otherwise. Omit to use the\ncaller's own organisation.\n","format":"uuid","type":"string"},"siteIds":{"description":"Scope the report to specific sites by their UUIDs. Each site must be\none the caller is authorised to access. Omit to return all sites in\nthe caller's authorised scope.\n","items":{"format":"uuid","type":"string"},"type":"array"},"startDate":{"description":"Lower bound of the date range (inclusive).","format":"date-time","type":"string"},"tableName":{"description":"The analytics table to query.","enum":["ts_doorway_hourly_unpivot","ts_path_hourly_unpivot","ts_people_count_monitors_hourly_unpivot","ts_space_hourly_unpivot"],"type":"string"},"timeGrain":{"description":"Time aggregation granularity. Hourly returns raw data, others aggregate.","enum":["hourly","daily","weekly","monthly","yearly"],"type":"string"}},"required":["endDate","startDate","tableName","timeGrain"],"type":"object"}},"components/schemas/TSAnalyticsReportResponse":{"id":"components/schemas/TSAnalyticsReportResponse","kind":"json-schema","title":"TSAnalyticsReportResponse","data":{"properties":{"hasMore":{"description":"Whether there are more records available.","readOnly":true,"type":"boolean"},"records":{"items":{"$ref":"#/components/schemas/TSAnalyticsRecord"},"readOnly":true,"type":"array"}},"type":"object"}},"components/schemas/TSAnalyticsSiteMetadata":{"id":"components/schemas/TSAnalyticsSiteMetadata","kind":"json-schema","title":"TSAnalyticsSiteMetadata","data":{"properties":{"id":{"description":"Site UUID. Pairs with the report's siteIds.","format":"uuid","readOnly":true,"type":"string"},"metricLabels":{"description":"Distinct metric label values for the site.","items":{"type":"string"},"readOnly":true,"type":"array"},"name":{"description":"Site display name.","readOnly":true,"type":"string"}},"type":"object"}},"components/schemas/TSAnalyticsTableMetadata":{"id":"components/schemas/TSAnalyticsTableMetadata","kind":"json-schema","title":"TSAnalyticsTableMetadata","data":{"properties":{"metricNames":{"description":"Distinct metric name values.","items":{"type":"string"},"readOnly":true,"type":"array"},"sites":{"description":"Sites available in the table, with their distinct metric labels.","items":{"$ref":"#/components/schemas/TSAnalyticsSiteMetadata"},"readOnly":true,"type":"array"},"tableName":{"description":"The analytics table name.","readOnly":true,"type":"string"}},"type":"object"}},"components/schemas/TalkBackData":{"id":"components/schemas/TalkBackData","kind":"json-schema","title":"TalkBackData","data":{"properties":{"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"recordedAt":{"format":"date-time","readOnly":true,"type":"string"},"talkbackDeviceId":{"description":"A ID of talkback device data for.","format":"uuid","type":"string"},"talkbackId":{"description":"A ID of talkback to fetch the data for.","format":"uuid","type":"string"},"transcript":{"type":"string"},"transcriptLang":{"type":"string"},"translated":{"type":"boolean"},"translation":{"type":"string"}}}},"components/schemas/TalkBackDevice":{"id":"components/schemas/TalkBackDevice","kind":"json-schema","title":"TalkBackDevice","data":{"properties":{"createdAt":{"format":"date-time","readOnly":true,"type":"string"},"description":{"type":"string"},"id":{"format":"uuid","type":"string","nullable":true},"siteId":{"format":"uuid","type":"string"},"state":{"enum":["active","deleted"],"type":"string"}},"type":"object"}},"components/schemas/TalkBackReportRequest":{"id":"components/schemas/TalkBackReportRequest","kind":"json-schema","title":"TalkBackReportRequest","data":{"properties":{"endDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the upper bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is non-inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]}]}]}],"format":"date","type":"string"},"startDate":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It is the lower bound of the date range for which to return data. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inclusive; i.e, the returned data will be for dates from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate-1"},"children":[]}]}]}],"format":"date","type":"string"},"talkbackDeviceId":{"description":"A ID of talkback to fetch the data for.","format":"uuid","type":"string"}},"type":"object"}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"properties":{"email":{"format":"email","type":"string"},"firstName":{"type":"string"},"id":{"type":"string","nullable":true},"lastName":{"type":"string"},"name":{"type":"string"},"organisationId":{"format":"uuid","type":"string"},"organisationName":{"type":"string","nullable":true},"roles":{"items":{"enum":["member","manager","admin","analyst","support"],"type":"string"},"type":"array"},"siteIds":{"description":"A list of IDs of the sites to user visibility.","items":{"format":"uuid","type":"string"},"type":"array"}},"required":["organisationId","email","firstName","lastName"],"type":"object"}},"components/schemas/VideoUploadMetrics":{"id":"components/schemas/VideoUploadMetrics","kind":"json-schema","title":"VideoUploadMetrics","data":{"properties":{"uploadSize":{"type":"integer"},"uploadTime":{"type":"number"}},"type":"object"}},"schema_42":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AggregatedApiRequestMetrics"},"type":"array"},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AggregatedVideoMetrics"},"type":"array"},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/LiveOccupancy"},"type":"array"},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Occupancy"},"type":"array"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PeelOffData"},"type":"array"},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PeopleCount"},"type":"array"},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"string","enum":["pending","awaiting_approval","approved","rejected"]},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/DwellTimeRequestResponse"},"type":"array"},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Organisation"},"type":"array"},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/User"},"type":"array"},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"string"},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ApiKeyLink"},"type":"array"},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"properties":{"expiresAt":{"description":"Optional expiry timestamp. Omit for a key that does not expire.","format":"date-time","type":"string"},"name":{"type":"string"},"organisationId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Target organisation for the key. Only honoured for callers with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" scope; org-scoped callers always create within their own organisation. Required when an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":":all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" caller has no active organisation (e.g. support users)."},"children":[]}]}]}],"format":"uuid","type":"string"},"role":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The role whose permissions the key is granted. The caller may only assign a role they are permitted to grant; assigning "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requires admin-level privileges."},"children":[]}]}]}],"enum":["admin","manager","member","analyst"],"type":"string"},"siteIds":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sites the key is scoped to. Required (and must be non-empty) for the site-scoped roles "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"member"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"analyst"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; must be omitted for the org-scoped roles "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"admin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"manager"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Every site must belong to the key's organisation."},"children":[]}]}]}],"items":{"format":"uuid","type":"string"},"type":"array"}},"required":["name","role"],"type":"object"},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"string","enum":["active","deleted"]},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Site"},"type":"array"},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":"array","items":{"enum":["running","paused","decommissioned"],"type":"string"}},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Camera"},"type":"array"},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"properties":{"name":{"type":"string"},"serialNumber":{"type":"string"},"siteId":{"format":"uuid","type":"string"}},"required":["serialNumber","siteId"],"type":"object"},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"properties":{"siteId":{"format":"uuid","type":"string"}},"required":["siteId"],"type":"object"},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"items":{"format":"date-time","type":"string"},"type":"array"},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"type":"string","enum":["running","paused"]},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"properties":{"cameraId":{"description":"the camera ID of the camera.","format":"uuid","type":"string"},"newState":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state to which the camera will be set: claimed cameras are processing video and have notifications on,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"claimed_paused cameras are not processing video, notifications are off and can be re-activated."},"children":[]}]}]}],"enum":["claimed","claimed_paused"],"type":"string"}},"required":["cameraId","newState"],"type":"object"},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"properties":{"cameraId":{"format":"uuid","type":"string"},"serialNumber":{"type":"string"}},"required":["cameraId","serialNumber"],"type":"object"},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Annotation"},"type":"array"},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"type":"string","enum":["offline_alert","occupancy_alert","camera_health_summary_alert"]},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Alert"},"type":"array"},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AlertNotificationGroup"},"type":"array"},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AlertCameraPosition"},"type":"array"},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AlertOccupancyMonitor"},"type":"array"},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AlertSite"},"type":"array"},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/NotificationGroup"},"type":"array"},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/NotificationGroupNotificationGroup"},"type":"array"},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/OccupancyMonitor"},"type":"array"},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/OccupancyMonitorCameraPosition"},"type":"array"},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PeopleCountMonitor"},"type":"array"},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PeopleCountMonitorCameraPosition"},"type":"array"},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PeelOffMonitor"},"type":"array"},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PeelOffMonitorCameraPosition"},"type":"array"},"id":"schema_83"}},"exampleStore":{},"securitySchemeStore":{"api_key":{"id":"api_key","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hoxton-issued API key, passed as a bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer hxt_live_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"in":"header","paramName":"Authorization"}},"servers":[{"url":"/_mock/v1","isMockServer":true,"description":"Mock server"},{"url":"https://nexus.hoxton.ai/api/v1"}],"logo":{"imageUrl":"https://s3.eu-west-1.amazonaws.com/hoxton.ai/hoxtonai_logo.svg","altText":"HoxtonAi"}},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/v1/index.json?download"},{"url":"/_bundle/v1/index.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"HoxtonAi API","description":"# Authentication\n\nAll API requests are authenticated with a Hoxton **API key**, passed as a\nBearer token in the `Authorization` header of every request:\n\n```\nAuthorization: Bearer hxt_live_.\n```\n\n## Creating an API key\n\nCreate and manage API keys for your organisation from your dashboard settings\nat [https://nexus.hoxton.ai/my-org/api-keys](https://nexus.hoxton.ai/my-org/api-keys), or\nprogrammatically via the `/api-keys` endpoints documented below.\n\nThe secret is shown **once**, at creation time — store it securely, as it\ncannot be retrieved afterwards. Each key belongs to a single organisation and\nis scoped to that organisation's data.\n\n## Using an API key\n\n```shell\ncurl https://nexus.hoxton.ai/api/v1/organisations \\\n -H 'Authorization: Bearer hxt_live_.'\n```\n\n## Expiry and revocation\n\nA key may be created with an optional expiry. Keys can be revoked at any time\nfrom the dashboard or via `DELETE /api-keys/{apiKeyId}`; a revoked or expired\nkey is rejected immediately on subsequent requests.\n"}},"baseSlug":"/v1","routesMapping":{}}