Learn about the API operation to get the status of a specific tenant.

These are the endpoints for obtaining the status of a particular tenant.

Request

 GET 
 {applicationURL}/reltio/status/tenant/<tenantID>

Request

GET 
 {applicationURL}/reltio/status/tenant/<tenantID>?details=all

Response

{  
   "Status":"Green",
   "IsExternalQueue":false,
   "Events queue size":0,
   "Matching queue size":0
}

Response

"Detailed tenant status" (details=all)

Example

{
    "Events queue details": {
        "Match Tokens Writer": {
            "size": 0,
            "process speed": 0.3,
            "instant process speed": 410427.5971516325,
            "fail count": 0,
            "error count": 0
        },
        "Merges": {
            "size": 0,
            "process speed": 0.1,
            "instant process speed": 8053.86208190724,
            "fail count": 0,
            "error count": 0
        },
        "ElasticSearch Activities Indexer": {
            "size": 0,
            "process speed": 0.3,
            "instant process speed": 467.25698858950386,
            "fail count": 0,
            "error count": 0
        },
        "ElasticSearch General Indexer": {
            "size": 0,
            "process speed": 0.4,
            "instant process speed": 618660.3425831647,
            "fail count": 0,
            "error count": 0
        },
        "Split Entities": {
            "size": 0,
            "process speed": 0.4,
            "instant process speed": 838404.5162056606,
            "fail count": 0,
            "error count": 0
        },
        "External Streaming": {
            "size": 0,
            "process speed": 0.1,
            "instant process speed": 230898.8893763421,
            "fail count": 0,
            "error count": 0
        },
        "Activity Log Long-Term Storage Processor": {
            "size": 0,
            "process speed": 0.3,
            "instant process speed": 443591.2159081667,
            "fail count": 0,
            "error count": 0
        },
        "History": {
            "size": 0,
            "process speed": 0.2,
            "instant process speed": 442448.5100546424,
            "fail count": 0,
            "error count": 0
        },
        "Predicate Query": {
            "size": 0,
            "process speed": 0.1,
            "instant process speed": 512575.1776927283,
            "fail count": 0,
            "error count": 0
        },
        "Analytics": {
            "size": 0,
            "process speed": 0.3,
            "instant process speed": 131379.47721186472,
            "fail count": 0,
            "error count": 0
        },
        "ElasticSearch Entities Indexer": {
            "size": 0,
            "process speed": 0.4,
            "instant process speed": 827386.4929155031,
            "fail count": 0,
            "error count": 0
        }
    },
    "Matching queue details": {},
    "Recent update time": <TIMESTAMP1>,
    "Skipped reference object update time": "unknown",
    "All background checks are finished for changes until": <TIMESTAMP2>,
    "Status": "Yellow",
    "IsExternalQueue": true,
    "Events queue size": 0,
    "Matching queue size": 0
}

• TIMESTAMP1: time of latest update in tenant.
• TIMESTAMP2: a background process for determining the right border of the time interval that was specified for tenant consistency checks.

TIMESTAMP2 < TIMESTAMP1 means that there are some updates in the tenant which are not checked by background consistency checks. In this case, the status becomes "YELLOW", which in turn means that not all background processes are finished and there are possible temporary inconsistencies.

Refer to Tenant Consistency Definition for detailed explanations of the fields for "Recent update time" and "All background checks are finished for changes until" and how these fields affect determining tenant status.