Create dashboard

POST/v2/dashboards

Create a dashboard from a dashboard document payload.

Body

application/json

Property	Type	Description
`dashboard`	`object`Required
`name`	`string`Required
`owner`	`string`Required	User ID of the dashboard owner. Use `X-AXIOM-EVERYONE` to make the dashboard accessible to all users in the organization.
`description`	`string`
`charts`	`unknown[]`Required
`layout`	`object[]`Required
`i`	`string`Required
`x`	`integer`Required
`y`	`integer`Required
`w`	`integer`Required
`h`	`integer`Required
`minW`	`integer`
`minH`	`number`
`maxW`	`integer`
`maxH`	`integer`
`static`	`boolean`
`refreshTime`	`integer`Required
`schemaVersion`	`integer`Required
`against`	`string`	Relative time comparison offset. Compares the current time window against a previous period offset by this duration. Mutually exclusive with `againstTimestamp` — setting one clears the other. Use an empty string or omit to disable comparison.
`againstTimestamp`	`string`	Absolute or relative timestamp to compare against. Mutually exclusive with `against` — setting one clears the other. Accepts ISO 8601, `now-{duration}` (e.g. `now-1h`), or epoch milliseconds as a string.
`timeWindowStart`	`string`Required	Start of the dashboard time range. Use `qr-now-{duration}` for a quick range relative to now, where duration is a number followed by `s` (seconds), `m` (minutes), `h` (hours), `d` (days), or `w` (weeks). Examples: `qr-now-5m`, `qr-now-1h`, `qr-now-7d`. Alternatively, use a Unix epoch millisecond timestamp as a string (e.g. `1704067200000`).
`timeWindowEnd`	`string`Required	End of the dashboard time range. Use `qr-now` for a rolling window that tracks the current time (pair with a `qr-now-{duration}` start), or a Unix epoch millisecond timestamp as a string (e.g. `1704153600000`).
`uid`	`string`	Optional dashboard UID. Must contain only letters, numbers, underscores, or hyphens, with length 1-128 when provided.
`message`	`string`
`overwrite`	`boolean`
`uid`	`string`	Stable external dashboard identifier (org-scoped unique).
`version`	`integer<int64>`	Required for updates when overwrite is false.

Request

curl -X POST 'https://api.axiom.co/v2/dashboards' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"dashboard":{"name":"string","owner":"string","description":"string","charts":["string"],"layout":[{"i":"string","x":0,"y":0,"w":0,"h":0,"minW":0,"minH":0,"maxW":0,"maxH":0,"static":true}],"refreshTime":15,"schemaVersion":2,"against":"-1h","againstTimestamp":"string","timeWindowStart":"string","timeWindowEnd":"string","uid":"string"},"message":"string","overwrite":false,"uid":"string","version":0}'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token RequiredRequest body application/json

Response

200Updated dashboard

application/json

201Created dashboard

application/json

400Invalid dashboard payload

application/json

409Dashboard already exists

application/json

412Version conflict

application/json

Property	Type	Description
`dashboard`	`object`Required
`createdAt`	`string<date-time>`Required
`createdBy`	`string`Required
`dashboard`	`object`Required
`name`	`string`Required
`owner`	`string`Required	User ID of the dashboard owner. Use `X-AXIOM-EVERYONE` to make the dashboard accessible to all users in the organization.
`description`	`string`
`charts`	`unknown[]`Required
`layout`	`object[]`Required
`i`	`string`Required
`x`	`integer`Required
`y`	`integer`Required
`w`	`integer`Required
`h`	`integer`Required
`minW`	`integer`
`minH`	`number`
`maxW`	`integer`
`maxH`	`integer`
`static`	`boolean`
`refreshTime`	`integer`Required
`schemaVersion`	`integer`Required
`against`	`string`	Relative time comparison offset. Compares the current time window against a previous period offset by this duration. Mutually exclusive with `againstTimestamp` — setting one clears the other. Use an empty string or omit to disable comparison.
`againstTimestamp`	`string`	Absolute or relative timestamp to compare against. Mutually exclusive with `against` — setting one clears the other. Accepts ISO 8601, `now-{duration}` (e.g. `now-1h`), or epoch milliseconds as a string.
`timeWindowStart`	`string`Required	Start of the dashboard time range. Use `qr-now-{duration}` for a quick range relative to now, where duration is a number followed by `s` (seconds), `m` (minutes), `h` (hours), `d` (days), or `w` (weeks). Examples: `qr-now-5m`, `qr-now-1h`, `qr-now-7d`. Alternatively, use a Unix epoch millisecond timestamp as a string (e.g. `1704067200000`).
`timeWindowEnd`	`string`Required	End of the dashboard time range. Use `qr-now` for a rolling window that tracks the current time (pair with a `qr-now-{duration}` start), or a Unix epoch millisecond timestamp as a string (e.g. `1704153600000`).
`uid`	`string`	Optional dashboard UID. Must contain only letters, numbers, underscores, or hyphens, with length 1-128 when provided.
`id`	`string`Required
`uid`	`string`Required
`updatedAt`	`string<date-time>`Required
`updatedBy`	`string`Required
`version`	`integer<int64>`Required
`overwritten`	`boolean`
`status`	`string`Required