dashboard | objectRequired | — |
└createdAt | string<date-time>Required | — |
└createdBy | stringRequired | — |
└dashboard | objectRequired | — |
└name | stringRequired | — |
└owner | stringRequired | 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 | stringRequired | — |
└x | integerRequired | — |
└y | integerRequired | — |
└w | integerRequired | — |
└h | integerRequired | — |
└minW | integer | — |
└minH | number | — |
└maxW | integer | — |
└maxH | integer | — |
└static | boolean | — |
└refreshTime | integerRequired | — |
└schemaVersion | integerRequired | — |
└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 | stringRequired | 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 | stringRequired | 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 | stringRequired | — |
└uid | stringRequired | — |
└updatedAt | string<date-time>Required | — |
└updatedBy | stringRequired | — |
└version | integer<int64>Required | — |
overwritten | boolean | — |
status | stringRequired | — |