Skip to main content
PUT
/
annotations
/
{id}
cURL
curl --request PUT \
  --url https://api.axiom.co/v2/annotations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "datasets": [
    "<string>"
  ],
  "description": "<string>",
  "endTime": "2023-11-07T05:31:56Z",
  "time": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "type": "<string>",
  "url": "<string>"
}'
{
  "datasets": [
    "my-dataset"
  ],
  "description": "Deploy new feature to the sales form",
  "endTime": "2024-02-06T11:39:28.382Z",
  "id": "ann_123",
  "time": "2024-02-06T10:39:28.382Z",
  "title": "Production deployment",
  "type": "deploy",
  "url": "https://example.com"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Unique ID of the annotation

Body

application/json
​
datasets
string[]

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

​
description
string

Explanation of the event the annotation marks on the charts

Maximum length: 512
​
endTime
string<date-time>

End time of the annotation

​
time
string<date-time>

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

Maximum length: 256
​
type
string

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

Maximum length: 256
​
url
string

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

Maximum length: 512

Response

200 - application/json

Annotation

​
datasets
string[]
required

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

Minimum length: 1
​
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.

​
type
string
required

Type 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<date-time> | 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