{"items":[{"type":"link","label":"Status API","link":"/ch/status-api","routeSlug":"/ch/status-api","content":{"contentType":"overview","meta":{"name":"Status API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/ch/status-api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/ch/status-api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"closed source","url":"https://www.sitecore.com"}]},{"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":"https://{server}","variables":{"server":{"default":"your-server"}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Status API (v1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Status API to monitor system health. Retrieve status information to verify system health and view system statistics."},"children":[]}]}]}]}],"sectionId":"/ch/status-api"}],"sectionId":"/ch/status-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"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":"To use the Status API, you need:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of your Content Hub server. You can get this from your Content Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Administrator. Enter this URL in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{{server}}"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" variable by hovering your mouse"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"over the variable in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Try it"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pane and then clicking "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"b","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An access token and the client ID. Both are sent with every request. You"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"can create a token through the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/users/content-hub/create-an-oauth-client.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content Hub"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interface"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or by "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#grant-flows"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requesting one to the API"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"itself"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"sectionId":"/ch/status-api/section/authentication"}]}]}},{"type":"link","label":"Authentication","link":"/ch/status-api/section/authentication","routeSlug":"/ch/status-api/section/authentication","content":null},{"type":"group","label":"Status","link":"/ch/status-api/status","routeSlug":"/ch/status-api/status","items":[{"label":"Retrieve overall system status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/status-api/status/status","routeSlug":"/ch/status-api/status/status","metadata":{"seo":{"title":"Retrieve overall system status","description":"Retrieves a summary of Content Hub system health, including minimal aggregated service status and links to detailed status resources. You do not need to authenticate to use this endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Status","name":"Retrieve overall system status","isWebhook":false,"pointer":"/paths/~1api~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve overall system status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a summary of Content Hub system health, including minimal aggregated service status and links to detailed status resources. You do not need to authenticate to use this endpoint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/status","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/status","href":"status/status","openApiOperationId":"Status","summary":"Retrieve overall system status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json:","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/StatusInfoResource"},"application/json":{"schemaId":"components/schemas/StatusInfoResource"},"text/json":{"schemaId":"components/schemas/StatusInfoResource"}},"schemaId":"components/schemas/StatusInfoResource"},{"code":"400","description":"Request not valid"}],"pointer":"/paths/~1api~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatusInfoResource","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/StatusInfoResource"},"application/json":{"schemaId":"components/schemas/StatusInfoResource"},"text/json":{"schemaId":"components/schemas/StatusInfoResource"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/status"}],"panels":[]}]},"httpPath":"/api/status"},{"label":"Retrieve the status for a specific message using its ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/status-api/status/messagedetail","routeSlug":"/ch/status-api/status/messagedetail","metadata":{"seo":{"title":"Retrieve the status for a specific message using its ID","description":"Retrieves detailed status information for a message, including the channel, creation time, priority, type, payload, and processing statuses.  To use this endpoint, you must have the MonitorSystemStatus privilege. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MessageDetail","name":"Retrieve the status for a specific message using its ID","isWebhook":false,"pointer":"/paths/~1api~1status~1messages~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the status for a specific message using its ID","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":"Retrieves detailed status information for a message, including the channel, creation time, priority, type, payload, and processing statuses. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"admonition","inline":true,"attributes":{"type":"info","name":"Note"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To use this endpoint, you must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MonitorSystemStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/ch/en/users/content-hub/privileges.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"privilege"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_939","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID of the message, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12345"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1status~1messages~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/status/messages/{id}","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_939"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/api/status/messages/{id}","href":"status/messagedetail","openApiOperationId":"MessageDetail","summary":"Retrieve the status for a specific message using its ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json:","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/MessageDetailResource"},"application/json":{"schemaId":"components/schemas/MessageDetailResource"},"text/json":{"schemaId":"components/schemas/MessageDetailResource"}},"schemaId":"components/schemas/MessageDetailResource"},{"code":"400","description":"Request not valid"},{"code":"401","description":"Unauthorized request"},{"code":"404","description":"Message not found"}],"pointer":"/paths/~1api~1status~1messages~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MessageDetailResource","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/MessageDetailResource"},"application/json":{"schemaId":"components/schemas/MessageDetailResource"},"text/json":{"schemaId":"components/schemas/MessageDetailResource"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/messagedetail"}],"panels":[]}]},"httpPath":"/api/status/messages/{id}"},{"label":"Retrieve the status of messages in a queue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/status-api/status/queuedetail","routeSlug":"/ch/status-api/status/queuedetail","metadata":{"seo":{"title":"Retrieve the status of messages in a queue","description":"Lists messages for a specific queue and status, including links for paging and message details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"QueueDetail","name":"Retrieve the status of messages in a queue","isWebhook":false,"pointer":"/paths/~1api~1status~1queues~1{queueName}~1{status}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the status of messages in a queue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists messages for a specific queue and status, including links for paging and message details."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"queueName","in":"path","schemaId":"schema_940","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the queue, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true},{"name":"status","in":"path","schemaId":"schema_940","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of messages to retrieve, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"deadletter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1status~1queues~1{queueName}~1{status}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"skip","in":"query","schemaId":"schema_941","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of records to skip before retrieving results, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"take","in":"query","schemaId":"schema_941","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of records to retrieve, for example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"25"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The maximum number that can be retrieved is 100."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1status~1queues~1{queueName}~1{status}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/status/queues/{queueName}/{status}","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"queueName","in":"path","required":true,"schemaId":"schema_940"},{"name":"status","in":"path","required":true,"schemaId":"schema_940"}],"query":[{"name":"skip","in":"query","schemaId":"schema_941"},{"name":"take","in":"query","schemaId":"schema_941"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","404"],"pointer":"/api/status/queues/{queueName}/{status}","href":"status/queuedetail","openApiOperationId":"QueueDetail","summary":"Retrieve the status of messages in a queue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json:","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/QueueDetailResource"},"application/json":{"schemaId":"components/schemas/QueueDetailResource"},"text/json":{"schemaId":"components/schemas/QueueDetailResource"}},"schemaId":"components/schemas/QueueDetailResource"},{"code":"400","description":"Invalid request parameters"},{"code":"401","description":"Unauthorized request"},{"code":"404","description":"Queue not found"}],"pointer":"/paths/~1api~1status~1queues~1{queueName}~1{status}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueueDetailResource","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/QueueDetailResource"},"application/json":{"schemaId":"components/schemas/QueueDetailResource"},"text/json":{"schemaId":"components/schemas/QueueDetailResource"}}},{"code":"400"},{"code":"401"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/queuedetail"}],"panels":[]}]},"httpPath":"/api/status/queues/{queueName}/{status}"},{"label":"Retrieve status information for all message queues","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/status-api/status/queues","routeSlug":"/ch/status-api/status/queues","metadata":{"seo":{"title":"Retrieve status information for all message queues","description":"Lists status information for all message queues, including statistics and links to detailed queue status resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Queues","name":"Retrieve status information for all message queues","isWebhook":false,"pointer":"/paths/~1api~1status~1queues/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve status information for all message queues","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists status information for all message queues, including statistics and links to detailed queue status resources."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/status/queues","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/status/queues","href":"status/queues","openApiOperationId":"Queues","summary":"Retrieve status information for all message queues"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json:","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/QueueCollectionResource"},"application/json":{"schemaId":"components/schemas/QueueCollectionResource"},"text/json":{"schemaId":"components/schemas/QueueCollectionResource"}},"schemaId":"components/schemas/QueueCollectionResource"},{"code":"401","description":"Unauthorized request"}],"pointer":"/paths/~1api~1status~1queues/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueueCollectionResource","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/QueueCollectionResource"},"application/json":{"schemaId":"components/schemas/QueueCollectionResource"},"text/json":{"schemaId":"components/schemas/QueueCollectionResource"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/queues"}],"panels":[]}]},"httpPath":"/api/status/queues"},{"label":"Retrieve the status of jobs within a specific retention period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/status-api/status/jobstatus","routeSlug":"/ch/status-api/status/jobstatus","metadata":{"seo":{"title":"Retrieve the status of jobs within a specific retention period","description":"Retrieves the status of jobs that occurred within a set time period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"JobStatus","name":"Retrieve the status of jobs within a specific retention period","isWebhook":false,"pointer":"/paths/~1api~1status~1jobs~1{retentionPeriod}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the status of jobs within a specific retention period","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the status of jobs that occurred within a set time period."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"retentionPeriod","in":"path","schemaId":"schema_942","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The retention period, for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"30"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" days."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1status~1jobs~1{retentionPeriod}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/status/jobs/{retentionPeriod}","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[{"name":"retentionPeriod","in":"path","required":true,"schemaId":"schema_942"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/api/status/jobs/{retentionPeriod}","href":"status/jobstatus","openApiOperationId":"JobStatus","summary":"Retrieve the status of jobs within a specific retention period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json:","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/JobStatusCollectionResource"},"application/json":{"schemaId":"components/schemas/JobStatusCollectionResource"},"text/json":{"schemaId":"components/schemas/JobStatusCollectionResource"}},"schemaId":"components/schemas/JobStatusCollectionResource"},{"code":"400","description":"Invalid request parameters"},{"code":"401","description":"Unauthorized request"}],"pointer":"/paths/~1api~1status~1jobs~1{retentionPeriod}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobStatusCollectionResource","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/JobStatusCollectionResource"},"application/json":{"schemaId":"components/schemas/JobStatusCollectionResource"},"text/json":{"schemaId":"components/schemas/JobStatusCollectionResource"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/jobstatus"}],"panels":[]}]},"httpPath":"/api/status/jobs/{retentionPeriod}"},{"label":"Retrieve the user status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/status-api/status/usersstatus","routeSlug":"/ch/status-api/status/usersstatus","metadata":{"seo":{"title":"Retrieve the user status","description":"Retrieves the total user count and related user status information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UsersStatus","name":"Retrieve the user status","isWebhook":false,"pointer":"/paths/~1api~1status~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the user status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the total user count and related user status information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/status/users","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/status/users","href":"status/usersstatus","openApiOperationId":"UsersStatus","summary":"Retrieve the user status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json:","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/UsersStatusResource"},"application/json":{"schemaId":"components/schemas/UsersStatusResource"},"text/json":{"schemaId":"components/schemas/UsersStatusResource"}},"schemaId":"components/schemas/UsersStatusResource"},{"code":"401","description":"Unauthorized request"}],"pointer":"/paths/~1api~1status~1users/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UsersStatusResource","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/UsersStatusResource"},"application/json":{"schemaId":"components/schemas/UsersStatusResource"},"text/json":{"schemaId":"components/schemas/UsersStatusResource"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/usersstatus"}],"panels":[]}]},"httpPath":"/api/status/users"},{"label":"Retrieve a hierarchical view of the system status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/status-api/status/servicestatus","routeSlug":"/ch/status-api/status/servicestatus","metadata":{"seo":{"title":"Retrieve a hierarchical view of the system status","description":"Retrieves the current status, message, and downstream service statuses for troubleshooting and diagnostics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"ServiceStatus","name":"Retrieve a hierarchical view of the system status","isWebhook":false,"pointer":"/paths/~1api~1status~1servicestatus/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a hierarchical view of the system status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the current status, message, and downstream service statuses for troubleshooting and diagnostics."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/status/servicestatus","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/status/servicestatus","href":"status/servicestatus","openApiOperationId":"ServiceStatus","summary":"Retrieve a hierarchical view of the system status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json:","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/ServiceStatusResource"},"application/json":{"schemaId":"components/schemas/ServiceStatusResource"},"text/json":{"schemaId":"components/schemas/ServiceStatusResource"}},"schemaId":"components/schemas/ServiceStatusResource"},{"code":"401","description":"Unauthorized request"}],"pointer":"/paths/~1api~1status~1servicestatus/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceStatusResource","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/ServiceStatusResource"},"application/json":{"schemaId":"components/schemas/ServiceStatusResource"},"text/json":{"schemaId":"components/schemas/ServiceStatusResource"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/servicestatus"}],"panels":[]}]},"httpPath":"/api/status/servicestatus"},{"label":"Retrieve the status and statistics for data storage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/status-api/status/datastoragestatus","routeSlug":"/ch/status-api/status/datastoragestatus","metadata":{"seo":{"title":"Retrieve the status and statistics for data storage","description":"Retrieves statistics and status information for the data storage layer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DataStorageStatus","name":"Retrieve the status and statistics for data storage","isWebhook":false,"pointer":"/paths/~1api~1status~1datastorage/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the status and statistics for data storage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves statistics and status information for the data storage layer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/status/datastorage","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/status/datastorage","href":"status/datastoragestatus","openApiOperationId":"DataStorageStatus","summary":"Retrieve the status and statistics for data storage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json:","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/DataStorageResource"},"application/json":{"schemaId":"components/schemas/DataStorageResource"},"text/json":{"schemaId":"components/schemas/DataStorageResource"}},"schemaId":"components/schemas/DataStorageResource"},{"code":"401","description":"Unauthorized request"}],"pointer":"/paths/~1api~1status~1datastorage/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataStorageResource","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/DataStorageResource"},"application/json":{"schemaId":"components/schemas/DataStorageResource"},"text/json":{"schemaId":"components/schemas/DataStorageResource"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/datastoragestatus"}],"panels":[]}]},"httpPath":"/api/status/datastorage"},{"label":"Retrieve the status and statistics for media storage","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/status-api/status/mediastorage","routeSlug":"/ch/status-api/status/mediastorage","metadata":{"seo":{"title":"Retrieve the status and statistics for media storage","description":"Retrieves the status and related statistics for the media storage layer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"MediaStorage","name":"Retrieve the status and statistics for media storage","isWebhook":false,"pointer":"/paths/~1api~1status~1mediastorage/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the status and statistics for media storage","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the status and related statistics for the media storage layer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/status/mediastorage","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/status/mediastorage","href":"status/mediastorage","openApiOperationId":"MediaStorage","summary":"Retrieve the status and statistics for media storage"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json:","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/MediaStorageResource"},"application/json":{"schemaId":"components/schemas/MediaStorageResource"},"text/json":{"schemaId":"components/schemas/MediaStorageResource"}},"schemaId":"components/schemas/MediaStorageResource"},{"code":"401","description":"Unauthorized request"}],"pointer":"/paths/~1api~1status~1mediastorage/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MediaStorageResource","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/MediaStorageResource"},"application/json":{"schemaId":"components/schemas/MediaStorageResource"},"text/json":{"schemaId":"components/schemas/MediaStorageResource"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/mediastorage"}],"panels":[]}]},"httpPath":"/api/status/mediastorage"},{"label":"Retrieve statistics for a specific tenant and time period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/status-api/status/videoindexing","routeSlug":"/ch/status-api/status/videoindexing","metadata":{"seo":{"title":"Retrieve statistics for a specific tenant and time period","description":"Retrieves the total number of seconds spent indexing videos for the specified period. If no dates are provided, the last calendar month is used."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"VideoIndexing","name":"Retrieve statistics for a specific tenant and time period","isWebhook":false,"pointer":"/paths/~1api~1status~1videoindexing/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve statistics for a specific tenant and time period","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the total number of seconds spent indexing videos for the specified period. If no dates are provided, the last calendar month is used."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_943","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start date for the calculation, for example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-05-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"to","in":"query","schemaId":"schema_943","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end date for the calculation, for example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-05-31"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1status~1videoindexing/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/status/videoindexing","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[{"name":"from","in":"query","schemaId":"schema_943"},{"name":"to","in":"query","schemaId":"schema_943"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/api/status/videoindexing","href":"status/videoindexing","openApiOperationId":"VideoIndexing","summary":"Retrieve statistics for a specific tenant and time period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json:","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/VideoIndexingDurationResource"},"application/json":{"schemaId":"components/schemas/VideoIndexingDurationResource"},"text/json":{"schemaId":"components/schemas/VideoIndexingDurationResource"}},"schemaId":"components/schemas/VideoIndexingDurationResource"},{"code":"400","description":"Invalid request parameters"},{"code":"401","description":"Unauthorized request"}],"pointer":"/paths/~1api~1status~1videoindexing/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VideoIndexingDurationResource","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/VideoIndexingDurationResource"},"application/json":{"schemaId":"components/schemas/VideoIndexingDurationResource"},"text/json":{"schemaId":"components/schemas/VideoIndexingDurationResource"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/videoindexing"}],"panels":[]}]},"httpPath":"/api/status/videoindexing"},{"label":"Retrieve the status and statistics for the search service","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/status-api/status/searchstatus","routeSlug":"/ch/status-api/status/searchstatus","metadata":{"seo":{"title":"Retrieve the status and statistics for the search service","description":"Retrieves statistics and health information for the search layer. This is useful for monitoring and diagnostics."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SearchStatus","name":"Retrieve the status and statistics for the search service","isWebhook":false,"pointer":"/paths/~1api~1status~1search/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the status and statistics for the search service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves statistics and health information for the search layer. This is useful for monitoring and diagnostics."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/status/search","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/status/search","href":"status/searchstatus","openApiOperationId":"SearchStatus","summary":"Retrieve the status and statistics for the search service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json:","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/SearchResource"},"application/json":{"schemaId":"components/schemas/SearchResource"},"text/json":{"schemaId":"components/schemas/SearchResource"}},"schemaId":"components/schemas/SearchResource"},{"code":"401","description":"Unauthorized request"}],"pointer":"/paths/~1api~1status~1search/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SearchResource","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/SearchResource"},"application/json":{"schemaId":"components/schemas/SearchResource"},"text/json":{"schemaId":"components/schemas/SearchResource"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/searchstatus"}],"panels":[]}]},"httpPath":"/api/status/search"},{"label":"Retrieve the status and statistics for the graph service","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/status-api/status/graphstatus","routeSlug":"/ch/status-api/status/graphstatus","metadata":{"seo":{"title":"Retrieve the status and statistics for the graph service","description":"Retrieves the status and statistics for the graph server and its workers. Use forceRefresh to bypass cached data if required."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GraphStatus","name":"Retrieve the status and statistics for the graph service","isWebhook":false,"pointer":"/paths/~1api~1status~1graph/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the status and statistics for the graph service","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":"Retrieves the status and statistics for the graph server and its workers. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"forceRefresh"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to bypass cached data if required."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"forceRefresh","in":"query","schemaId":"schema_944","description":"Whether to force a refresh of the graph status information."}],"pointer":"/paths/~1api~1status~1graph/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/status/graph","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[{"name":"forceRefresh","in":"query","schemaId":"schema_944"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/api/status/graph","href":"status/graphstatus","openApiOperationId":"GraphStatus","summary":"Retrieve the status and statistics for the graph service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json:","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/GraphResource"},"application/json":{"schemaId":"components/schemas/GraphResource"},"text/json":{"schemaId":"components/schemas/GraphResource"}},"schemaId":"components/schemas/GraphResource"},{"code":"400","description":"Invalid request parameters"},{"code":"401","description":"Unauthorized request"}],"pointer":"/paths/~1api~1status~1graph/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GraphResource","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/GraphResource"},"application/json":{"schemaId":"components/schemas/GraphResource"},"text/json":{"schemaId":"components/schemas/GraphResource"}}},{"code":"400"},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/graphstatus"}],"panels":[]}]},"httpPath":"/api/status/graph"},{"label":"Retrieve the system status","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/ch/status-api/status/systemstatus","routeSlug":"/ch/status-api/status/systemstatus","metadata":{"seo":{"title":"Retrieve the system status","description":"Retrieves status information about the system, including search and data storage statistics. This endpoint is deprecated. Use the graph, data storage, or search resource endpoints instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"SystemStatus","name":"Retrieve the system status","deprecated":true,"isWebhook":false,"pointer":"/paths/~1api~1status~1system/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the system status","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves status information about the system, including search and data storage statistics. This endpoint is deprecated.  Use the graph, data storage, or search resource endpoints instead."},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/status/system","servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/status/system","href":"status/systemstatus","openApiOperationId":"SystemStatus","summary":"Retrieve the system status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json:","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/SystemResource"},"application/json":{"schemaId":"components/schemas/SystemResource"},"text/json":{"schemaId":"components/schemas/SystemResource"}},"schemaId":"components/schemas/SystemResource"},{"code":"401","description":"Unauthorized request"}],"pointer":"/paths/~1api~1status~1system/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SystemResource","mediaTypes":["application/json:","application/json","text/json"],"mediaTypeContent":{"application/json:":{"schemaId":"components/schemas/SystemResource"},"application/json":{"schemaId":"components/schemas/SystemResource"},"text/json":{"schemaId":"components/schemas/SystemResource"}}},{"code":"401"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status/systemstatus"}],"panels":[]}]},"httpPath":"/api/status/system"}],"content":{"contentType":"group","meta":{"name":"Status"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Status","showPageActions":true},{"nodeType":"markdoc","content":"The status endpoint is used to retrieve information about the health and status of the system."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/status","summary":"Retrieve overall system status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/status","deprecated":false},{"title":"/api/status/messages/{id}","summary":"Retrieve the status for a specific message using its ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/messagedetail","deprecated":false},{"title":"/api/status/queues/{queueName}/{status}","summary":"Retrieve the status of messages in a queue","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/queuedetail","deprecated":false},{"title":"/api/status/queues","summary":"Retrieve status information for all message queues","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/queues","deprecated":false},{"title":"/api/status/jobs/{retentionPeriod}","summary":"Retrieve the status of jobs within a specific retention period","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/jobstatus","deprecated":false},{"title":"/api/status/users","summary":"Retrieve the user status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/usersstatus","deprecated":false},{"title":"/api/status/servicestatus","summary":"Retrieve a hierarchical view of the system status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/servicestatus","deprecated":false},{"title":"/api/status/datastorage","summary":"Retrieve the status and statistics for data storage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/datastoragestatus","deprecated":false},{"title":"/api/status/mediastorage","summary":"Retrieve the status and statistics for media storage","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/mediastorage","deprecated":false},{"title":"/api/status/videoindexing","summary":"Retrieve statistics for a specific tenant and time period","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/videoindexing","deprecated":false},{"title":"/api/status/search","summary":"Retrieve the status and statistics for the search service","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/searchstatus","deprecated":false},{"title":"/api/status/graph","summary":"Retrieve the status and statistics for the graph service","prefix":{"name":"get","color":"get"},"badges":[],"link":"/status/graphstatus","deprecated":false},{"title":"/api/status/system","summary":"Retrieve the system status","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/status/systemstatus","deprecated":true}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/DataStorageResource":{"id":"components/schemas/DataStorageResource","kind":"json-schema","title":"DataStorageResource","data":{"type":"object","properties":{"statistics":{"type":"object","description":"Statistics of the data storage","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Resource representing status and statistics for the data storage (excluding media storage)"}},"components/schemas/EntityCopyOptions":{"id":"components/schemas/EntityCopyOptions","kind":"json-schema","title":"EntityCopyOptions","data":{"type":"object","description":"Options for copying an entity, including profile and property/relation options.","properties":{"copy_profile_identifier":{"type":"string","description":"Identifier of a copy profile that could be used for copying an entity.","nullable":true},"copy_profile_id":{"type":"integer","description":"Identifier of a copy profile that could be used for copying an entity.","format":"int64","nullable":true},"destination_entity_id":{"type":"integer","description":"ID of an entity that will be updated by copying values from an original entity.","format":"int64","nullable":true},"relation_copy_options":{"type":"array","items":{"$ref":"#/components/schemas/RelationCopyOptions"},"description":"Relation copy options if copy profile is not specified.","nullable":true},"property_copy_options":{"type":"array","items":{"$ref":"#/components/schemas/PropertyCopyOptions"},"description":"Property copy options if copy profile is not specified.","nullable":true}},"additionalProperties":false}},"components/schemas/FieldFilterRequestResource":{"id":"components/schemas/FieldFilterRequestResource","kind":"json-schema","title":"FieldFilterRequestResource","data":{"type":"object","description":"Request resource for filtering fields in queries.","properties":{"name":{"type":"string","description":"Name of the field to filter.","nullable":true},"definition":{"type":"string","description":"Definition of the field to filter.","nullable":true},"group_identifier":{"type":"string","description":"Identifier for the filter group.","nullable":true},"operator":{"$ref":"#/components/schemas/FilterOperator","description":"Operator to use for filtering."},"values":{"type":"array","items":{},"description":"Values to filter by.","nullable":true},"nested_values":{"type":"array","items":{"$ref":"#/components/schemas/FieldFilterRequestResource"},"description":"Nested filter values for complex filters.","nullable":true},"hidden":{"type":"boolean","description":"Whether the filter is hidden."},"type":{"$ref":"#/components/schemas/RequestedFilterType","description":"The type of filter requested."},"role":{"type":"string","description":"Role associated with the filter.","nullable":true},"visible":{"type":"boolean","description":"Whether the filter is visible."},"multi_select":{"type":"boolean","description":"Whether multiple values can be selected."},"selection_pool_specs":{"$ref":"#/components/schemas/SelectionPoolSpecs","description":"Specifications for the selection pool."}},"additionalProperties":false}},"components/schemas/FilterOperator":{"id":"components/schemas/FilterOperator","kind":"json-schema","title":"FilterOperator","data":{"enum":["None","Equals","LessThan","GreaterThan","Between","StartsWith","EndsWith","Contains","FacetEquals","DoesNotContain","DoesNotStartWith","DoesNotEndWith","LessThanOrEquals","GreaterThanOrEquals","DoesNotEqual","AnyOf","AllOf","NoneOf","Missing","Exists","Changed"],"type":"string"}},"components/schemas/GraphResource":{"id":"components/schemas/GraphResource","kind":"json-schema","title":"GraphResource","data":{"type":"object","properties":{"status":{"type":"object","description":"Status of the graph server, usually taken over from the .","nullable":true},"statistics":{"type":"object","description":"Statistics for the graph server, usually taken over from the graph. API","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Resource representing status and statistics of the graph server."}},"components/schemas/IndexMappingMetaResource":{"id":"components/schemas/IndexMappingMetaResource","kind":"json-schema","title":"IndexMappingMetaResource","data":{"type":"object","properties":{"main_template_version":{"type":"string","nullable":true},"audit_template_version":{"type":"object","additionalProperties":{"type":"string"},"nullable":true}},"additionalProperties":false}},"components/schemas/JobStatusCollectionResource":{"id":"components/schemas/JobStatusCollectionResource","kind":"json-schema","title":"JobStatusCollectionResource","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/JobStatusResource"},"description":"Gets or sets the list of items.","nullable":true},"total_items":{"type":"integer","description":"Gets or sets the total number of items.","format":"int64","nullable":true},"returned_items":{"type":"integer","description":"Gets or sets the number of returned items.","format":"int64","nullable":true},"offset":{"type":"integer","description":"Gets or sets the offset of the items.","format":"int32","nullable":true},"next":{"$ref":"#/components/schemas/Link"},"previous":{"$ref":"#/components/schemas/Link"},"identifier":{"type":"string","description":"Gets or sets the identifier of the resource.","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":{}}},"components/schemas/JobStatusResource":{"id":"components/schemas/JobStatusResource","kind":"json-schema","title":"JobStatusResource","data":{"type":"object","properties":{"type":{"type":"string","nullable":true},"total":{"type":"integer","format":"int64"},"condition":{"type":"object","additionalProperties":{"type":"integer","format":"int64","nullable":true},"nullable":true},"average_pickup_time_seconds":{"type":"integer","description":"Average pickup time of the last hour in seconds.","format":"int32"},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false}},"components/schemas/Link":{"id":"components/schemas/Link","kind":"json-schema","title":"Link","data":{"type":"object","properties":{"href":{"type":"string","description":"Gets or sets the URI that points to the resource this link refers to.","nullable":true},"filename_properties":{"type":"array","items":{"type":"string"},"description":"Gets or sets the URI that points to the resource this link refers to.","nullable":true},"title":{"type":"string","description":"Gets or sets the title that describes this link.","nullable":true},"templated":{"type":"boolean","description":"Whether the contained URI is a template.","default":false}},"additionalProperties":false,"description":"Represents a link to a resource."}},"components/schemas/MediaStorageResource":{"id":"components/schemas/MediaStorageResource","kind":"json-schema","title":"MediaStorageResource","data":{"type":"object","properties":{"statistics":{"type":"object","description":"Statistics for the media storage.","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Resource representing status and statistics for data storage (excluding media storage)."}},"components/schemas/MessageDetailResource":{"id":"components/schemas/MessageDetailResource","kind":"json-schema","title":"MessageDetailResource","data":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the message in the messaging system.","format":"int64"},"channel":{"type":"string","description":"Channel this message was published to.","nullable":true},"created_on":{"type":"string","description":"Time the message was created.","format":"date-time"},"priority":{"type":"integer","description":"Priority of the message. The higher the priority, the sooner the consumption on queues supporting the message prioritization.","format":"int64"},"reference_count":{"type":"integer","description":"Number of references of this message in various queues located in the same location as this message. A message with a reference count equal to 0 will be automatically garbage collected after a period of time (depends on the configuration).","format":"int64"},"type":{"type":"string","description":".NET type of the message content (payload).","nullable":true},"payload":{"type":"object","description":"The message content.","nullable":true},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/MessageStatus"},"description":"Collection of message status information on various queues. The actual state of the message in all applicable queues is not part of these statuses.","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Resource representing the message."}},"components/schemas/MessageStatus":{"id":"components/schemas/MessageStatus","kind":"json-schema","title":"MessageStatus","data":{"type":"object","properties":{"queue":{"type":"string","description":"Queue name this status item is associated with.","nullable":true},"date_of_last_pickup_by_worker":{"type":"string","description":"Gets or sets the timestamp indicating the last time the message was picked up by a worker.","format":"date-time","nullable":true},"current_processing_time":{"type":"string","description":"Gets the current processing time, defined as the duration between the current time and the most recent pickup time by a worker.","format":"date-span","nullable":true,"readOnly":true},"waiting_time_to_get_processed":{"type":"string","description":"Gets the time the message spent waiting in the queue before being picked up for processing.","format":"date-span","nullable":true,"readOnly":true},"instance_identifier":{"type":"string","description":"Instance identifier of the queue subscriber that is consuming the message at the moment.","nullable":true},"exception":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exception that caused the message to fail on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stylelabs.M.Base.Web.Api.Models.MessageStatus.Queue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional data attached for given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stylelabs.M.Base.Web.Api.Models.MessageStatus.Queue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the message was re-pushed on the queue."},"children":[]}]}]}],"nullable":true}},"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message status as part of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stylelabs.M.Base.Web.Api.Models.Status.MessageDetailResource"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that reflects the contents of the messaging message status item."},"children":[]}]}]}]}},"components/schemas/PropertyCopyOptions":{"id":"components/schemas/PropertyCopyOptions","kind":"json-schema","title":"PropertyCopyOptions","data":{"type":"object","properties":{"property":{"type":"string","description":"Property name.","nullable":true},"method":{"type":"string","description":"Copy method name.","nullable":true},"new_value":{"type":"string","description":"New value of the property.","nullable":true}},"additionalProperties":false}},"components/schemas/QueueCollectionResource":{"id":"components/schemas/QueueCollectionResource","kind":"json-schema","title":"QueueCollectionResource","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/QueueResource"},"description":"Gets or sets the list of items.","nullable":true},"total_items":{"type":"integer","description":"Gets or sets the total number of items.","format":"int64","nullable":true},"returned_items":{"type":"integer","description":"Gets or sets the number of returned items.","format":"int64","nullable":true},"offset":{"type":"integer","description":"Gets or sets the offset of the items.","format":"int32","nullable":true},"next":{"$ref":"#/components/schemas/Link"},"previous":{"$ref":"#/components/schemas/Link"},"identifier":{"type":"string","description":"Gets or sets the identifier of the resource.","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":{}}},"components/schemas/QueueDetailResource":{"id":"components/schemas/QueueDetailResource","kind":"json-schema","title":"QueueDetailResource","data":{"type":"object","description":"Resource providing details about messages in a queue, including paging information.","properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/Link"},"description":"List of message links in the queue.","nullable":true},"total_messages":{"type":"integer","format":"int64","description":"Total number of messages in the queue.","nullable":true},"returned_messages":{"type":"integer","format":"int64","description":"Number of messages returned in the current response.","nullable":true},"offset":{"type":"integer","format":"int32","description":"Offset of the returned messages.","nullable":true},"next":{"$ref":"#/components/schemas/Link","description":"Link to the next page of results."},"previous":{"$ref":"#/components/schemas/Link","description":"Link to the previous page of results."},"self":{"$ref":"#/components/schemas/Link","description":"Link to this resource."}},"additionalProperties":false}},"components/schemas/QueueResource":{"id":"components/schemas/QueueResource","kind":"json-schema","title":"QueueResource","data":{"type":"object","properties":{"name":{"type":"string","description":"Name of the queue.","nullable":true},"parentqueuename":{"type":"string","description":"Name of the parent queue this queue consumes messages from.","nullable":true},"in_queue_type":{"type":"string","description":"Type of the in-queue of this subscription.","nullable":true},"pattern":{"type":"string","description":"Pattern for message digestion.","nullable":true},"location":{"type":"string","description":"Location of the queue.","nullable":true},"in":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of messages in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"format":"int64"},"wip":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of messages in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"wip"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"format":"int64"},"in_detail":{"$ref":"#/components/schemas/Link"},"wip_detail":{"$ref":"#/components/schemas/Link"},"complete_detail":{"$ref":"#/components/schemas/Link"},"deadletter_detail":{"$ref":"#/components/schemas/Link"},"complete":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of messages in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"format":"int64"},"deadletter":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of messages in the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"i","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deadletter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"format":"int64"},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Resource providing information and statistics of a single messaging queue (subscription)."}},"components/schemas/RelationCopyOptions":{"id":"components/schemas/RelationCopyOptions","kind":"json-schema","title":"RelationCopyOptions","data":{"type":"object","properties":{"relation":{"type":"string","description":"Relation name.","nullable":true},"method":{"type":"string","description":"Copy method name.","nullable":true},"related_copy_options":{"$ref":"#/components/schemas/EntityCopyOptions"},"new_value":{"type":"array","items":{"type":"integer","format":"int64"},"description":"New value of the relation.","nullable":true}},"additionalProperties":false}},"components/schemas/RequestedFilterType":{"id":"components/schemas/RequestedFilterType","kind":"json-schema","title":"RequestedFilterType","data":{"enum":["FieldFilter","InFilter","DynamicFilter","Nested","IdFilter","SelectionPoolFilter"],"type":"string"}},"components/schemas/SearchResource":{"id":"components/schemas/SearchResource","kind":"json-schema","title":"SearchResource","data":{"type":"object","properties":{"statistics":{"type":"object","description":"Statistics of the search services.","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Resource representing status and statistics of the search services"}},"components/schemas/SelectionPoolSpecs":{"id":"components/schemas/SelectionPoolSpecs","kind":"json-schema","title":"SelectionPoolSpecs","data":{"type":"object","description":"Specifications for selection pools used in filters.","properties":{"pool_id":{"type":"integer","format":"int64","description":"The unique identifier of the selection pool."},"sub_pool_id":{"type":"integer","format":"int64","nullable":true,"description":"The unique identifier of the sub-pool, if applicable."}},"additionalProperties":false}},"components/schemas/ServiceStatusResource":{"id":"components/schemas/ServiceStatusResource","kind":"json-schema","title":"ServiceStatusResource","data":{"type":"object","properties":{"service_status_label":{"type":"string","description":"Label for Stylelabs.M.Base.Web.Api.Models.Status.ServiceStatusResource.Status","nullable":true,"readOnly":true},"service_status_message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message describing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stylelabs.M.Base.Web.Api.Models.Status.ServiceStatusResource.Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in more detail."},"children":[]}]}]}],"nullable":true},"data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional additional JSON serializable data for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stylelabs.M.Framework.Infrastructure.ServiceStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"aggregated_service_status_label":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Label for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stylelabs.M.Base.Web.Api.Models.Status.ServiceStatusResource.AggregatedStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"readOnly":true},"downstream_services":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ServiceStatusResource"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional collection of individual downstream services. This value can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Hierarchical service status information."}},"components/schemas/StatusInfoResource":{"id":"components/schemas/StatusInfoResource","kind":"json-schema","title":"StatusInfoResource","data":{"type":"object","properties":{"product_version":{"type":"string","nullable":true},"build_date":{"type":"string","nullable":true},"rollout_date":{"type":"string","description":"The date the tenant was last updated. Unlike the build or release date, this property is tenant specific.","format":"date-time","nullable":true},"hostname":{"type":"string","nullable":true},"region_name":{"type":"string","nullable":true},"aggregated_service_status_label":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Label for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Stylelabs.M.Base.Web.Api.Models.Status.StatusInfoResource.AggregatedStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"readOnly":true},"index_template_versions":{"$ref":"#/components/schemas/IndexMappingMetaResource","nullable":true},"queues":{"$ref":"#/components/schemas/Link"},"jobs":{"$ref":"#/components/schemas/Link"},"users":{"$ref":"#/components/schemas/Link"},"license":{"$ref":"#/components/schemas/Link"},"system":{"$ref":"#/components/schemas/Link"},"error":{"$ref":"#/components/schemas/Link"},"data_storage":{"$ref":"#/components/schemas/Link"},"media_storage":{"$ref":"#/components/schemas/Link"},"search":{"$ref":"#/components/schemas/Link"},"graph":{"$ref":"#/components/schemas/Link"},"service_status":{"$ref":"#/components/schemas/Link"},"version":{"$ref":"#/components/schemas/Link"},"publishing":{"$ref":"#/components/schemas/Link"},"video-indexing-duration":{"$ref":"#/components/schemas/Link"},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"The status information as visible for the status controller."}},"components/schemas/SystemResource":{"id":"components/schemas/SystemResource","kind":"json-schema","title":"SystemResource","data":{"type":"object","properties":{"redis":{"type":"object","description":"Data storage statistics.","nullable":true},"elasticsearch":{"type":"object","description":"Search statistics.","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Obsolete resource agregating statistics of the data storage and search services."}},"components/schemas/UsersStatusResource":{"id":"components/schemas/UsersStatusResource","kind":"json-schema","title":"UsersStatusResource","data":{"type":"object","properties":{"total_user_count":{"type":"integer","format":"int64"},"active_user_count":{"type":"integer","format":"int64"},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false}},"components/schemas/VideoIndexingDurationResource":{"id":"components/schemas/VideoIndexingDurationResource","kind":"json-schema","title":"VideoIndexingDurationResource","data":{"type":"object","properties":{"from":{"type":"string","description":"The date video indexing is calculated from.","format":"date"},"to":{"type":"string","description":"The date video indexing is calculated to.","format":"date"},"seconds":{"type":"integer","description":"Number of seconds it takes the tenant to index the videos.","format":"int64"},"message":{"type":"string","description":"The message when the calculation fails.","nullable":true},"self":{"$ref":"#/components/schemas/Link"}},"additionalProperties":false,"description":"Resource representing the number of seconds spent indexing videos."}},"schema_939":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_939"},"schema_940":{"kind":"json-schema","data":{"type":"string"},"id":"schema_940"},"schema_941":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_941"},"schema_942":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":30},"id":"schema_942"},"schema_943":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_943"},"schema_944":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_944"}},"exampleStore":{},"securitySchemeStore":{"OAuth2":{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{}},"authorizationCode":{"authorizationUrl":"/oauth/authorize","tokenUrl":"/oauth/token","scopes":{}}}}},"servers":[{"url":"https://{server}","variables":{"server":{"default":"your-server"}}}],"specType":"openapi"},"options":{"hideInfoMetadata":true,"sanitize":true,"sortRequiredPropsFirst":true,"corsProxyUrl":"https://cors.redoc.ly","mockServer":{"off":true,"position":"off"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/ch/status-api/index.json?download"},{"url":"/_bundle/ch/status-api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Status API","description":"\nUse the Status API to monitor system health. Retrieve status information to verify system health and view system statistics.\n\n## Authentication\n\nTo use the Status API, you need:\n\n- The URL of your Content Hub server. You can get this from your Content Hub\n  Administrator. Enter this URL in the <b>{{server}}</b> variable by hovering your mouse\n  over the variable in the <b>Try it</b> pane and then clicking <b>Edit</b>.\n\n- An access token and the client ID. Both are sent with every request. You \n  can create a token through the [Content Hub\n  interface](https://doc.sitecore.com/ch/en/users/content-hub/create-an-oauth-client.html) \n  or by [requesting one to the API\n  itself](https://doc.sitecore.com/ch/en/developers/cloud-dev/oauth-tokens.html#grant-flows).\n","product":"Content Hub"}},"baseSlug":"/ch/status-api","routesMapping":{}}