> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# List metrics

> Lists observed metric definitions keyed by metric name.

`axiom.listMetrics` lists observed metric definitions keyed by metric name. Each definition includes its type, aggregation behavior, and unit; the discovery window defaults to the previous 30 minutes.

```ts automations/axiom-list-metrics.automation.ts theme={null}
import { automation, onHttpRequest } from "automate.ax"
import { axiom } from "automate.ax/axiom"

export default automation("List metrics", () => {
  onHttpRequest({ scope: "automation" })
  axiom.listMetrics({ datasetName: "metrics" })
})
```

## Inputs

`datasetName` is required. Omit `startTime` and `endTime` to search the previous 30 minutes, or provide RFC3339 timestamps for a fixed window. `edgeUrl` defaults to the US East 1 (AWS) edge at `"https://us-east-1.aws.edge.axiom.co"`. Set it to the edge that stores the dataset; a custom edge URL must use HTTPS on `*.edge.axiom.co`.

## Output

Returns an object keyed by metric name. Each value contains `type`, `temporality`, and nullable `unit`. No metrics observed in the window returns an empty object.

## Permission and failures

The API token needs the dataset-level `query|read` capability for `datasetName`. Axiom returns an error when the metrics dataset is missing or inaccessible, and rejects invalid time windows. Request-rate limits return `429`, while exhausted query-cost limits return `430`. Automate.ax uses Axiom's reset timing when available.