AXaxiom
annotations

GET /annotations

Changed on

Lists annotations in the organization. Filter by datasets, or by a time range with both start and end at most 100 days apart. Without filters, returns all annotations.

Request

Query parameters

datasetsstring[]

Optional: Filter for dataset names.

startstring

Optional: Filter for events after this date. Use RFC3339 time format.

endstring

Optional: Filter for events before this date. Use RFC3339 time format.

Response

Annotations.

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