On this page

Services Endpoints

Access information about your monitored services, including instrumentation scores and telemetry quality metrics.

List services

Retrieve a paginated list of services for the authenticated organization

GET /services

Query Parameters

Parameter	Type	Default	Description
`limit`	integer	50	Maximum number of items to return (1-100)
`offset`	integer	-	Number of items to skip for pagination

Response

{
  "data": [
    {
      "created_at": "2025-09-17T06:53:58.781Z",
      "environment": "example_environment",
      "first_seen_at": "2025-09-17T06:53:58.781Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "instrumentation_score": {
        "calculated_timestamp": "2025-09-17T06:53:58.781Z",
        "calculation_window_seconds": 2592000,
        "created_at": "2025-09-17T06:53:58.781Z",
        "evaluated_rule_ids": [
          "example_item"
        ],
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "score": 85
      },
      "last_seen_at": "2025-09-17T06:53:58.781Z",
      "name": "quote",
      "organization_id": "org_2AbCdEfGhIjKlMnOpQrStUvWxYz",
      "updated_at": "2025-09-17T06:53:58.781Z",
      "version": "2.0.2"
    }
  ],
  "meta": {
    "timestamp": "2023-12-31T23:59:59Z"
  }
}

Example Request

curl -X GET "https://api.ollygarden.cloud/api/v1/services" \
  -H "Authorization: Bearer og_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Get service by ID

Retrieve a specific service by its unique identifier

GET /services/{id}

Path Parameters

Parameter	Type	Description
`id`	string (uuid)	Service ID

Response

{
  "data": {
    "created_at": "2025-09-17T06:53:58.781Z",
    "environment": "example_environment",
    "first_seen_at": "2025-09-17T06:53:58.781Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "instrumentation_score": {
      "calculated_timestamp": "2025-09-17T06:53:58.781Z",
      "calculation_window_seconds": 2592000,
      "created_at": "2025-09-17T06:53:58.781Z",
      "evaluated_rule_ids": [
        "example_item"
      ],
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "score": 85
    },
    "last_seen_at": "2025-09-17T06:53:58.781Z",
    "name": "quote",
    "organization_id": "org_2AbCdEfGhIjKlMnOpQrStUvWxYz",
    "updated_at": "2025-09-17T06:53:58.781Z",
    "version": "2.0.2"
  },
  "meta": {
    "timestamp": "2023-12-31T23:59:59Z"
  }
}

Example Request

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

List insights for a service

Retrieve a paginated list of insights for a specific service

GET /services/{id}/insights

Path Parameters

Parameter	Type	Description
`id`	string (uuid)	Service ID

Query Parameters

Parameter	Type	Default	Description
`status`	string	active	Filter by insight status (comma-separated)
`limit`	integer	50	Maximum number of items to return (1-100)
`offset`	integer	-	Number of items to skip for pagination

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

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