GET
/
annotations

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

datasets
string[]

Optional: Filter for dataset names.

start
string

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

end
string

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

Response

200 - application/json
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 | null

End time of the annotation

id
string
required
time
string
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.