AXaxiom
annotations

POST /annotations

Changed on

Creates an annotation on one or more existing datasets. If you omit time, Axiom uses the time of the request. time can't be in the future.

Request

Request body

datasetsstring[] required

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

descriptionstring

Explanation of the event the annotation marks on the charts

endTimestring date-time

End time of the annotation

timestring 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.

titlestring

Summary of the annotation that appears on the charts

typestring required

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

urlstring

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

Response

Created annotation.

datasetsstring[] required

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

descriptionstring

Explanation of the event the annotation marks on the charts

endTimestring date-time nullable

End time of the annotation

idstring required
timestring 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.

titlestring

Summary of the annotation that appears on the charts

typestring required

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

urlstring

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

Example response

{
  "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"
}

Changes