getAnnotations

Get annotations

get
/v2/annotations

Query Parameters

ParamTypeDescription

datasets

array <string>

Optional: Filter for dataset names.

Properties

start

string

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

Properties

end

string

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

Properties

Responses

200
Annotation, an {schema.type} with the following properties:
PropertyTypeDescription

datasets

array <string>

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

Properties

description

string

Explanation of the event the annotation marks on the charts

Properties

endTime

string

End time of the annotation

Properties

id

string

Properties

time

string

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.

Properties

title

string

Summary of the annotation that appears on the charts

Properties

type

string

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

Properties

url

string

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

Properties

Was this page helpful?