annotations

GET /annotations/{id}

Changed on Oct 16, 2026

Retrieves an annotation by its ID.

Request

Base URL
https://api.axiom.co/v2
Auth
OAuth 2
Authorization codehttps://accounts.google.com/o/oauth2/v2/auth
Token URLhttps://www.googleapis.com/oauth2/v4/token
Scopesannotations|read
TypeScript
https://skmtc.dev/axiom/apis/axiom-public-api/docs/annotations/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Unique ID of the annotation

Response

Annotation.

datasetsstring[] required

array<string> of dataset names for which the annotation appears on charts

descriptionstring

Explanation of the event the annotation marks on the charts

endTimestring date-time nullable

End time of the annotation

idstring required

timestring date-time required

Time the annotation marks on the charts. If you don't include this field, Axiom assigns the time of the API request to the annotation.

titlestring

Summary of the annotation that appears on the charts

typestring required

Type of the event marked by the annotation. Use only alphanumeric characters or hyphens. For example, "production-deployment".

urlstring

URL relevant for the event marked by the annotation. For example, link to GitHub pull request.

Example response

{
  "datasets": [
    "my-dataset"
  ],
  "description": "Deploy new feature to the sales form",
  "endTime": "2024-02-06T11:39:28.382Z",
  "id": "ann_123",
  "time": "2024-02-06T10:39:28.382Z",
  "title": "Production deployment",
  "type": "deploy",
  "url": "https://example.com"
}

Changes

Oct 16, 2026v2fbc1b8430feb Revision changes
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history