Annotation Endpoints
Retrieve Annotation
Get annotation by ID
GET
/
annotations
/
{id}
Authorizations
Authorization
string
headerrequiredThe access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
id
string
requiredUnique ID of the annotation
Response
200 - application/json
datasets
string[]
requiredarray<string> of dataset names for which the annotation appears on charts
id
string
requiredtime
string
requiredTime the annotation marks on the charts. If you don't include this field, Axiom assigns the time of the API request to the annotation.
type
string
requiredType of the event marked by the annotation. Use only alphanumeric characters or hyphens. For example, "production-deployment".
Maximum length:
256
description
string
Explanation of the event the annotation marks on the charts
Maximum length:
512
endTime
string | null
End time of the annotation
title
string
Summary of the annotation that appears on the charts
Maximum length:
256
url
string
URL relevant for the event marked by the annotation. For example, link to GitHub pull request.
Maximum length:
512
Was this page helpful?