System - Observability Read

Endpoint

/o/system/observability

Overview

Collects observability payloads from installed modules and returns them as a list.

Authentication

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions

• Requires authenticated dashboard user access to management-read endpoints.

Request Parameters

Parameter	Type	Required	Description
api_key	String	Yes (or use auth_token)	Dashboard API key.
auth_token	String	Yes (or use api_key)	Dashboard auth token.

Examples

Example 1: Read observability payloads

/o/system/observability?api_key=YOUR_API_KEY

[
  {
    "service": "kafka",
    "status": "ok"
  }
]

Response

Success Response

[
  {
    "service": "kafka",
    "status": "ok",
    "lag": 0
  },
  {
    "service": "aggregator",
    "status": "ok",
    "secondsBehind": 5
  }
]

Response Fields

Field	Type	Description
(root)	Array	Array of observability objects returned by installed modules.
service	String	Example module-level service identifier. Fields vary by module.
status	String	Example health/state field. Fields vary by module.

Error Responses

Status Code: 500 Internal Server Error

{
  "result": "Error collecting observability data"
}

Behavior

Behavior Modes

Mode	Trigger	Response Shape
Successful collection	Observability providers return data successfully	Array of fulfilled observability payloads (can be empty).
Collection failure	Dispatch callback returns error	Wrapped error message.

Operational Considerations

• Response schema is module-dependent; treat payload entries as typed-by-service objects.
• A module failure does not guarantee a full endpoint failure unless collection returns a terminal error.

Limitations

• Returned fields are not fixed across installations.

Related Endpoints

• Kafka Status Read
• Aggregator Status Read

Implementation details

Database Collections

This endpoint does not directly read or write database collections.