Axiom
Overview

Update dashboard

Update a dashboard by UID.

PUT/v2/dashboards/uid/{uid}
Features

Send the token in the Authorization: Bearer API_TOKEN header. See Tokens for which token types this endpoint accepts.

Input6
Authorizationheaderrequired
Sent from your browser straight to the API — never to Docsbook, never stored.
uidstring · pathrequired
(path)
dashboardobject · bodyrequired
Show child attributes12
namestringrequired
ownerstringrequired
User ID of the dashboard owner. Use X-AXIOM-EVERYONE to make the dashboard accessible to all users in the organization.
descriptionstring
chartsobject[]required
layoutobject[]required
refreshTimeintegerrequired
One of: 15, 60, 300.
schemaVersionintegerrequired
One of: 2.
againststring
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. One of: -1h, -3h, -6h, -12h, -1d, -3d, -7d, -1w, -2w, -3w, -30d, -60d, -90d.
againstTimestampstring
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.
timeWindowStartstringrequired
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).
timeWindowEndstringrequired
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).
uidstring
Optional dashboard UID. Must contain only letters, numbers, underscores, or hyphens, with length 1-128 when provided.
messagestring · body
overwriteboolean · body
versioninteger · body
Required for updates when overwrite is false.
Output3
dashboardobject
Show child attributes12
namestring
ownerstring
User ID of the dashboard owner. Use X-AXIOM-EVERYONE to make the dashboard accessible to all users in the organization.
descriptionstring
chartsobject[]
layoutobject[]
refreshTimeinteger
One of: 15, 60, 300.
schemaVersioninteger
One of: 2.
againststring
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. One of: -1h, -3h, -6h, -12h, -1d, -3d, -7d, -1w, -2w, -3w, -30d, -60d, -90d.
againstTimestampstring
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.
timeWindowStartstring
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).
timeWindowEndstring
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).
uidstring
Optional dashboard UID. Must contain only letters, numbers, underscores, or hyphens, with length 1-128 when provided.
overwrittenboolean
statusstring
One of: created, updated.
Responses
200Updated dashboard
201Created dashboard
400Invalid dashboard payload
409Dashboard already exists
412Version conflict
Example input
curl -X PUT 'https://api.axiom.co/v2/dashboards/uid/{uid}' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "dashboard": {
      "name": "string",
      "owner": "string",
      "description": "string",
      "charts": [
        {
          "id": "string",
          "type": "TimeSeries",
          "name": "string",
          "query": {
            "apl": null,
            "queryOptions": null
          }
        }
      ],
      "layout": [
        {
          "i": "string",
          "x": 0,
          "y": 0,
          "w": 0,
          "h": 0,
          "minW": 0,
          "minH": 0,
          "maxW": 0,
          "maxH": 0,
          "static": false
        }
      ],
      "refreshTime": 15,
      "schemaVersion": 2,
      "against": "-1h",
      "againstTimestamp": "string",
      "timeWindowStart": "string",
      "timeWindowEnd": "string",
      "uid": "string"
    }
  }'
Example output
{
  "dashboard": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "dashboard": {
      "name": "string",
      "owner": "string",
      "description": "string",
      "charts": [
        {
          "id": null,
          "type": "TimeSeries",
          "name": null,
          "query": null
        }
      ],
      "layout": [
        {
          "i": null,
          "x": null,
          "y": null,
          "w": null,
          "h": null,
          "minW": null,
          "minH": null,
          "maxW": null,
          "maxH": null,
          "static": null
        }
      ],
      "refreshTime": 15,
      "schemaVersion": 2,
      "against": "-1h",
      "againstTimestamp": "string",
      "timeWindowStart": "string",
      "timeWindowEnd": "string",
      "uid": "string"
    },
    "id": "string",
    "uid": "string",
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "version": 0
  },
  "overwritten": false,
  "status": "created"
}

Updated

Was this page helpful?