Reference

ObserveSpec schema

ObserveSpec v0: one SlashObserve dashboard. Absent fields mean the default.

Fields

Field	Type	Description
`specVersion` (required)	`"0"`
`title` (required)	`string`
`description`	`string`
`tags`	array of `string`	At most 20 items.
`time` (required)	`timeRange`
`refresh`	`string`	Auto-refresh interval such as 30s, 1m, 1h or 1d.
`timePicker`	`object`	What the time picker offers: hidden removes it, refreshIntervals replaces the auto-refresh choices and quickRanges the preset ranges. A refresh that is not in refreshIntervals is still allowed.
`liveNow`	`boolean`	Refresh the dashboard every few seconds until a refresh interval is chosen, as Grafana’s live now redraws time charts continuously.
`timezone`	`string`	browser, utc or an IANA zone such as Asia/Kolkata. Relative times (now/d, now-1d) resolve in this zone.
`weekStart`	`"monday"`, `"sunday"`, `"saturday"`	The first day of the week for now/w. Absent means monday.
`fiscalYearStartMonth`	`integer`	The month the fiscal year starts in for now/fy and now/fQ, 0 (January) to 11 (December). Absent means 0. Between 0 and 11.
`nowDelay`	`string`	How far behind the real time now is for every relative time, such as 30s or 1m.
`cursorSync`	`"off"`, `"crosshair"`, `"tooltip"`	How hovering one time chart shows on the others: off, crosshair (the hovered time is marked on every time chart) or tooltip (their tooltips open too). Grafana’s graphTooltip 0, 1 and 2.
`variables`	array of `variable`	At most 20 items.
`links`	array of `dashboardLink`	At most 20 items.
`panels` (required)	array of `panel`	At most 200 panels in total, row children included; ids are unique across all of them. At most 200 items.

Variable types

Panel types

The JSON Schema is published at /schemas/observespec.v0.json.

Generated from spec/schema/observespec.v0.json at bac0fe39. Report a problem.

View as Markdown