Hanzo
OpenapiO11y

Reports whether the integration's logs and metrics have been received over the…

Reports whether the integration's logs and metrics have been received over the lookback window, so the console can show a live connection state.

GET /v1/o11y/integrations/{integrationId}/connection_status

Addresshttps://api.hanzo.ai/v1/o11y/integrations/{integrationId}/connection_status
MethodGET
OperationGetIntegrationConnectionStatus
AuthAuthorization: Bearer $HANZO_API_KEY

Reports whether the integration's logs and metrics have been received over the lookback window, so the console can show a live connection state. An integration that is not installed answers with an empty status rather than an error. Viewer gate.

Request

2 fields.

FieldInTypeRequiredDescription
integrationIdpathstringyes
lookback_secondsqueryintegerLookbackSeconds is how far back to look for received telemetry, in seconds.

Response

StatusBodyMeaning
200o11y.O11yConnectionStatusOutok

200 body — 8 fields.

FieldInTypeAlwaysDescription
databodyo11y.IntegrationConnectionStatus
data.logsbodyo11y.SignalConnectionStatus
data.logs.last_received_frombodystringresource identifier
data.logs.last_received_ts_msbodyintegerepoch milliseconds
data.metricsbodyo11y.SignalConnectionStatus
data.metrics.last_received_frombodystringresource identifier
data.metrics.last_received_ts_msbodyintegerepoch milliseconds
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y integrations connection_status <integrationId>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page