List annotations - Automate.ax

axiom.listAnnotations lists annotations. You can limit results to selected datasets or a time range. Results include IDs, type, timestamps, and optional title, description, URL, and end time.

automations/axiom-list-annotations.automation.ts

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

export default automation("List annotations", () => {
  onHttpRequest({ scope: "automation" })
  axiom.listAnnotations({
    datasets: ["production"],
    startTime: "2026-08-01T00:00:00Z",
    endTime: "2026-09-01T00:00:00Z",
  })
})

Inputs

All inputs are optional. datasets filters by dataset names or IDs. startTime and endTime bound the annotation window using Axiom time expressions or timestamps. Omitting all three returns every annotation visible to the token.

Output

Returns an array of annotations. Each item includes id, datasets, type, and time, plus endTime, title, description, and url when present. An empty match returns [].

Permission and failures

The API token needs the organization-level annotations|read capability. Axiom rejects invalid time expressions; authentication and permission failures are returned as action errors.