Skip to content
Site Qwality Site Qwality Site Qwality Docs

Open a shared dashboard.

GET
/public/dashboards/{token}
 
curl --request GET \
  --url https://api.siteqwality.com/public/dashboards/example

Unauthenticated. 404 when the link is unknown, paused, expired or its dashboard deleted.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
token
required
string

The link token

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The dashboard and what a viewer may change

Media type application/json

What GET /public/dashboards/{token} serves: no ids, authors or account details.

object
name
required
string
description
string | null
definition
required

Widgets not allowed on shares keep their place and title with an empty config.

object
schema_version
required
integer format: int32
settings
object
default_time

A window of T2 tokens (now, now-2h) or instants (ISO 8601, epoch milliseconds), resolved when the query is compiled, so a stored view stays rolling.

object
from
required
string
to
required
string
refresh
string
Allowed values: auto off 30s 1m 5m 15m
timezone

None follows the viewer’s browser; otherwise UTC or an IANA zone.

string | null
crosshair
string
Allowed values: shared off
variables
Array<object>
object
name
required
string
label
string | null
source
required
string
Allowed values: monitors incidents rum logs metrics traces
field
required
string
metric
string | null
multi
boolean
include_all
boolean
default

["*"] is All.

Array<string>
values

A fixed list instead of values from the data.

array | null
widgets
Array
object
One of:
object
config
required
object
queries
required
Array<object>
object
id
required
string
source
required
string
Allowed values: monitors incidents rum logs metrics traces
measure
required
string
aggregation
One of:
null
filters
Array<object>
object
field
required
string
op
required
string
Allowed values: in not_in contains not_contains gt gte lt lte
values
required
Array<string>
group_by
Array<string>
metric

Metrics source only: the metric name (or $var).

string | null
hidden
boolean
alias
string | null
formulas
Array<object>
object
id
required
string
expr
required
string
alias
string | null
unit
One of:
null
hidden
boolean
display
string
Allowed values: line area bars
stacked
boolean
series_limit
integer format: int32
legend
string
Allowed values: auto table compact none
legend_columns
Array<string>
Allowed values: value avg min max sum
y_axis
One of:
null
unit
One of:
null
decimals
integer | null format: int32
thresholds
Array<object>

A horizontal marker on a time series.

object
value
required
number format: double
tone
required
string
Allowed values: ok warn danger
style
string
Allowed values: line band
label
string | null
compare
One of:
null
overlays
Array<string>
Allowed values: incidents downtime
palette
string
Allowed values: categorical cool warm status
type
required
string
Allowed values: timeseries
id
required
string
title
string | null
description
string | null
layout
required
object
x
required
integer format: int32
y
required
integer format: int32
w
required
integer format: int32
h
required
integer format: int32
time
One of:
null
settings
required
object
allowed_times
required
Array<string>
default_time
required
string
timezone

The dashboard’s zone; null follows the viewer’s browser.

string | null
theme
required
string
Allowed values: light dark auto
variables
required

Every dashboard variable, with how the viewer may use it.

object
key
additional properties
object
locked
required
boolean
allowed
array | null
Example 
{
  "definition": {
    "settings": {
      "refresh": "auto",
      "crosshair": "shared"
    },
    "variables": [
      {
        "source": "monitors"
      }
    ],
    "widgets": [
      {
        "config": {
          "queries": [
            {
              "source": "monitors",
              "aggregation": "avg",
              "filters": [
                {
                  "op": "in"
                }
              ]
            }
          ],
          "formulas": [
            {
              "unit": "ms"
            }
          ],
          "display": "line",
          "legend": "auto",
          "legend_columns": [
            "value"
          ],
          "y_axis": {
            "scale": "linear"
          },
          "unit": "ms",
          "thresholds": [
            {
              "tone": "ok",
              "style": "line"
            }
          ],
          "compare": "previous_period",
          "overlays": [
            "incidents"
          ],
          "palette": "categorical"
        },
        "type": "timeseries"
      }
    ]
  },
  "settings": {
    "theme": "light"
  }
}

404

Section titled “404 ”

The link is not available

429

Section titled “429 ”

Too many requests

500

Section titled “500 ”

Internal server error