List all annotations

GET/v2/annotations

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.

Parameters

Property	Type	Location	Description
`datasets`	`string[]`	`query`	Optional: Filter for dataset names.
`start`	`string`	`query`	Optional: Filter for events after this date. Use RFC3339 time format.
`end`	`string`	`query`	Optional: Filter for events before this date. Use RFC3339 time format.

Request

curl -X GET 'https://api.axiom.co/v2/annotations' \
  -H 'Authorization: Bearer API_TOKEN'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token Requireddatasets querystart queryend query

Response

200Annotations.

application/json

400Invalid `start` or `end`, only one of them set, `end` before `start`, or a range longer than 100 days.

Property	Type	Description
`datasets`	`string[]`Required	array<string> of dataset names for which the annotation appears on charts
`description`	`string`	Explanation of the event the annotation marks on the charts
`endTime`	`string<date-time>`	End time of the annotation
`id`	`string`Required
`time`	`string<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.
`title`	`string`	Summary of the annotation that appears on the charts
`type`	`string`Required	Type of the event marked by the annotation. Use only alphanumeric characters or hyphens. For example, "production-deployment".
`url`	`string`	URL relevant for the event marked by the annotation. For example, link to GitHub pull request.