dashboards

GET /api/v1/dashboards/default/

Shows the default dashboard defined by the system

Request

Response

pkinteger
urlstring
stats_urlstring
services_selectedstring[]

Include checks from this list

services_tagsstring[]

Include checks with one or more of the selected tags

orderinginteger

Sidebar ordering for this dashboard

created_atstring date-time
namestring

The displayed name for this dashboard

is_pinnedboolean

Whether this dashboard is pinned to the sidebar

metrics_show_sectionboolean

Show/hide the Summary Metrics section at the top of this dashboard

metrics_for_all_checksboolean

Include metrics from all checks, not just the selected checks

services_show_sectionboolean

Show/hide the check cards from this dashboard

services_num_to_show4 | 8 | 12 | 16 | 20 | 24

Number of check cards to show in the Checks section

match_all_tagsboolean

When true, checks must have all selected tags; when false, checks need only one

services_include_upboolean

Include/exclude checks which are currently up

services_include_downboolean

Include/exclude checks which are currently down

services_include_pausedboolean

Include/exclude checks which are currently paused

services_include_maintenanceboolean

Include/exclude checks which are manually marked for maintenance

services_primary_sort'cached_ordering' | 'device__address' | '-created_at' | 'is_paused,cached_state_is_up' | '-cached_last_down_alert_at' | '-cached_response_time'

The primary value for ordering the checks

services_secondary_sort'cached_ordering' | 'device__address' | '-created_at' | 'is_paused,cached_state_is_up' | '-cached_last_down_alert_at' | '-cached_response_time'

The secondary value for ordering the checks, if the primary value is the same

services_show_uptimeboolean

Show the 24h uptime percentage on each check card

services_show_response_timeboolean

Show the response time graph or metric on each check card

alerts_show_sectionboolean

Show/hide the Latest Alerts section from this dashboard

alerts_for_all_checksboolean

Show/hide alerts globally across all checks, rather than only for checks selected in the Checks tab

alerts_include_ignoredboolean

Include/exclude alerts marked as "ignored" in the alerts listing

alerts_include_resolvedboolean

Include/exclude alerts that are no longer down in the alerts listing

alerts_num_to_show5 | 10 | 15

Number of alerts to show in the Latest Alerts section

charts_show_sectionboolean

Changes

No recorded changes to this operation across all 1 revision of this API.