Retrieve annotation

GET/v2/annotations/{id}

Retrieves an annotation by its ID.

Parameters

Property	Type	Location	Description
`id`	`string`Required	`path`	Unique ID of the annotation

curl -X GET 'https://api.axiom.co/v2/annotations/ID' \
  -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 Requiredid pathRequired

200Annotation.

application/json

400Invalid annotation ID.

404Annotation not found.

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.