OllyGarden REST API

OllyGarden’s read-only REST API service that provides secure, high-performance, and programmatic access to observability insights and telemetry quality data.

Base URL

All API requests should be made to the following base URL:

https://api.ollygarden.cloud/api/v1

Authentication

The OllyGarden REST API uses Bearer token authentication. All requests must include a valid API key in the Authorization header.

Authorization: Bearer og_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Enter ‘Bearer ’ followed by your API key (e.g., ‘Bearer og_sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx’) to authenticate requests.

Response Format

All successful API responses return data in JSON format with the following structure:

{
  "data": {}, // or []
  "meta": {
    "timestamp": "2023-12-31T23:59:59Z",
    "total": 150  // Present for paginated responses
  },
  "links": {
    // Pagination links when applicable
  }
}

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of requests:

Error responses include detailed information to help you debug issues:

{
  "error": {
    "code": "INVALID_PARAMETERS",
    "message": "Invalid request parameters",
    "details": {
      "field": "Additional context about the error"
    }
  },
  "meta": {
    "timestamp": "2023-12-31T23:59:59Z"
  }
}

Available Resources

The OllyGarden REST API provides access to the following resources:

Insights

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

Services

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

Getting Started

1. Obtain an API key from your OllyGarden dashboard
2. Set up authentication by including your API key in the Authorization header
3. Make your first request to list your services: GET /api/v1/services
4. Explore insights for specific services to understand telemetry quality