This page explains how to use annotations to add context to your dashboard elements.
API_TOKEN
with the Axiom API token you have generated. For added security, store the API token in an environment variable.Replace DATASET_NAME
with the name of the Axiom dataset where you want to send data.AXIOM_DOMAIN
with api.axiom.co
if your organization uses the US region, and with api.eu.axiom.co
if your organization uses the EU region. For more information, see Regions.Replace API_TOKEN
with the Axiom API token you have generated. For added security, store the API token in an environment variable.Replace DATASET_NAME
with the name of the Axiom dataset where you want to send data.id
field. This is the annotation ID that you can later use to change or delete the annotation.
AXIOM_DOMAIN
with api.axiom.co
if your organization uses the US region, and with api.eu.axiom.co
if your organization uses the EU region. For more information, see Regions.Replace API_TOKEN
with the Axiom API token you have generated. For added security, store the API token in an environment variable.start
is an ISO timestamp that specifies the beginning of the time interval.end
is an ISO timestamp that specifies the end of the time interval.datasets
is the list of datasets whose annotations you want to get information about. Separate datasets by commas, for example datasets=my-dataset1,my-dataset2
.my-dataset
:
id
field. This is the annotation ID that you can later use to change or delete the annotation. For more information on the other fields, see Annotation object.
To get information about a specific annotation, use the following API request:
AXIOM_DOMAIN
with api.axiom.co
if your organization uses the US region, and with api.eu.axiom.co
if your organization uses the EU region. For more information, see Regions.Replace ANNOTATION_ID
with the ID of the annotation.Replace API_TOKEN
with the Axiom API token you have generated. For added security, store the API token in an environment variable.AXIOM_DOMAIN
with api.axiom.co
if your organization uses the US region, and with api.eu.axiom.co
if your organization uses the EU region. For more information, see Regions.Replace ANNOTATION_ID
with the ID of the annotation. For more information about how to determine the annotation ID, see Get information about annotations.Replace API_TOKEN
with the Axiom API token you have generated. For added security, store the API token in an environment variable.In the payload, specify the properties of the annotation that you want to change. The example above adds an endTime
field to the annotation created above. For more information on the allowed fields, see Annotation object.AXIOM_DOMAIN
with api.axiom.co
if your organization uses the US region, and with api.eu.axiom.co
if your organization uses the EU region. For more information, see Regions.Replace ANNOTATION_ID
with the ID of the annotation. For more information about how to determine the annotation ID, see Get information about annotations.Replace API_TOKEN
with the Axiom API token you have generated. For added security, store the API token in an environment variable.datasets
is the list of dataset names for which the annotation appears on charts.id
is the unique ID of the annotation.description
is an explanation of the event the annotation marks on the charts.time
is an ISO timestamp value that specifies the time the annotation marks on the charts.title
is a summary of the annotation that appears on the charts.type
is the type of the event marked by the annotation. For example, production deployment.url
is the URL relevant for the event marked by the annotation. For example, link to GitHub pull request.endTime
is an ISO timestamp value that specifies the end time of the annotation.AXIOM_DOMAIN
with api.axiom.co
if your organization uses the US region, and with api.eu.axiom.co
if your organization uses the EU region. For more information, see Regions.Replace API_TOKEN
with the Axiom API token you have generated. For added security, store the API token in an environment variable.Example histogram with annotation