Get annotation - Automate.ax

axiom.getAnnotation retrieves one annotation by ID. The result includes its datasets, type, time range, title, description, and URL.

automations/axiom-get-annotation.automation.ts

import { automation, onHttpRequest } from "automate.ax"
import { axiom } from "automate.ax/axiom"

export default automation("Get annotation", () => {
  onHttpRequest({ scope: "automation" })
  axiom.getAnnotation({ annotationId: "annotation-id" })
})

Input

annotationId is required and must identify an annotation visible to the connected token.

Output

Returns the annotation’s id, datasets, type, and time, plus endTime, title, description, and url when present.

Permission and failures

The API token needs the organization-level annotations|read capability. Axiom returns an error when the annotation does not exist or the token cannot access it.