Skip to main content

OllyGarden API is now available! Access telemetry quality insights programmatically to integrate with your existing tools and workflows. Explore API

Insights Endpoints

Insights Endpoints

Retrieve telemetry quality insights and recommendations generated by OllyGarden’s analysis engine.

Get insight by ID

Retrieve a specific insight by its unique identifier

GET /insights/{id}

Path Parameters

ParameterTypeDescription
idstring (uuid)Insight ID

Response

{
"data": {
"attributes": {
"signal_type": "METRICS",
"resource_attributes": "{\"service.name\":\"example-service\",\"service.version\":\"1.0.0\",\"deployment.environment\":\"production\"}",
"discouraged_attributes": "[\"os.description\",\"host.ip\"]"
},
"created_at": "2025-09-17T06:53:58.781Z",
"id": "123e4567-e89b-12d3-a456-426614174000",
"insight_type": {
"created_at": "2025-09-17T06:53:58.781Z",
"description": "Detects metrics with discouraged resource attributes (host.ip, host.mac, os.description) that increase cardinality and payload size without providing meaningful observability insights",
"display_name": "Discouraged Resource Attribute",
"id": "123e4567-e89b-12d3-a456-426614174000",
"impact": "Low",
"instrumentation_score_rule_id": "example_instrumentation_score_rule_id",
"name": "quote",
"remediation_instructions": "Update your OpenTelemetry SDK or instrumentation libraries to exclude host.ip, host.mac, and os.description from resource attributes during collection",
"signal_type": "metric",
"updated_at": "2025-09-17T06:53:58.781Z"
},
"service_id": "123e4567-e89b-12d3-a456-426614174000",
"status": "active",
"telemetry_ts": "2025-09-17T06:53:58.781Z",
"trace_id": "example_trace_id",
"updated_at": "2025-09-17T06:53:58.781Z"
},
"meta": {
"timestamp": "2023-12-31T23:59:59Z"
}
}

Example Request

Terminal window
curl -X GET "https://api.ollygarden.cloud/api/v1/insights/123e4567-e89b-12d3-a456-426614174000" \
-H "Authorization: Bearer og_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"