Hanzo
OpenapiO11y

Returns one integration's full detail — its overview, configuration steps,…

Returns one integration's full detail — its overview, configuration steps, collected data and assets — together with its installation record when the org…

GET /v1/o11y/integrations/{integrationId}

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

Returns one integration's full detail — its overview, configuration steps, collected data and assets — together with its installation record when the org has installed it. Viewer gate.

Request

1 field.

FieldInTypeRequiredDescription
integrationIdpathstringyes

Response

StatusBodyMeaning
200o11y.O11yIntegrationOutok

200 body — 61 fields.

FieldInTypeAlwaysDescription
databodyo11y.Integration
data.assetsbodyo11y.IntegrationAssets
data.assets.alertsbodyany[]
data.assets.dashboardsbodyobject[]
data.assets.dashboards[].*bodyobject
data.assets.logsbodyo11y.LogsAssets
data.assets.logs.pipelinesbodyo11y.PostablePipeline[]
data.assets.logs.pipelines[].aliasbodystring
data.assets.logs.pipelines[].configbodyany[]
data.assets.logs.pipelines[].descriptionbodystring
data.assets.logs.pipelines[].enabledbodyboolean
data.assets.logs.pipelines[].filterbodyo11y.FilterSet
data.assets.logs.pipelines[].filter.itemsbodyo11y.FilterItem[]
data.assets.logs.pipelines[].filter.items[].keybodyo11y.AttributeKey
data.assets.logs.pipelines[].filter.items[].key.dataTypebodystring
data.assets.logs.pipelines[].filter.items[].key.isColumnbodyboolean
data.assets.logs.pipelines[].filter.items[].key.isJSONbodyboolean
data.assets.logs.pipelines[].filter.items[].key.keybodystring
data.assets.logs.pipelines[].filter.items[].key.typebodystring
data.assets.logs.pipelines[].filter.items[].opbodystring
data.assets.logs.pipelines[].filter.items[].valuebodyobject
data.assets.logs.pipelines[].filter.opbodystring
data.assets.logs.pipelines[].idbodystring
data.assets.logs.pipelines[].namebodystring
data.assets.logs.pipelines[].orderIdbodyinteger
data.authorbodyo11y.IntegrationAuthor
data.author.emailbodystring
data.author.homepagebodystring
data.author.namebodystring
data.categoriesbodystring[]
data.configurationbodyo11y.IntegrationConfigStep[]
data.configuration[].instructionsbodystring
data.configuration[].titlebodystring
data.connection_testsbodyo11y.IntegrationConnectionTests
data.connection_tests.logsbodyo11y.LogsConnectionTest
data.connection_tests.logs.attribute_keybodystring
data.connection_tests.logs.attribute_valuebodystring
data.connection_tests.metricsbodystring[]Metric names expected to have been received for the integration.
data.data_collectedbodyo11y.DataCollectedForIntegration
data.data_collected.logsbodyo11y.integrations.CollectedLogAttribute[]
data.data_collected.logs[].namebodystring
data.data_collected.logs[].pathbodystring
data.data_collected.logs[].typebodystring
data.data_collected.metricsbodyo11y.integrations.CollectedMetric[]
data.data_collected.metrics[].descriptionbodystring
data.data_collected.metrics[].namebodystring
data.data_collected.metrics[].typebodystring
data.data_collected.metrics[].unitbodystring
data.descriptionbodystring
data.iconbodystring
data.idbodystring
data.installationbodyo11y.InstalledIntegration
data.installation.configbodyobject
data.installation.config.*bodyobject
data.installation.idbodyany
data.installation.installed_atbodystring (date-time)
data.installation.org_idbodystring
data.installation.typebodystring
data.overviewbodystring
data.titlebodystring
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y integrations get <integrationId>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page