Run stored widgets within the link's allowed times and variables; logs and traces are denied. The saved zone and default resolution apply. Monitor URLs are removed from results.
POST
/public/dashboards/{token}/query
const url = 'https://api.siteqwality.com/public/dashboards/example/query';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"time":{"from":"example","to":"example"},"timezone":"example","variables":{"additionalProperty":["example"]},"widget_ids":["example"],"max_points":1}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.siteqwality.com/public/dashboards/example/query \ --header 'Content-Type: application/json' \ --data '{ "time": { "from": "example", "to": "example" }, "timezone": "example", "variables": { "additionalProperty": [ "example" ] }, "widget_ids": [ "example" ], "max_points": 1 }'Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” token
required
string
The link token
Request Body required
Section titled “Request Body required ” Media type application/json
object
time
required
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
timezone
string | null
variables
object
key
additional properties
Array<string>
widget_ids
required
Array<string>
max_points
integer | null format: int32
Example generated
{ "time": { "from": "example", "to": "example" }, "timezone": "example", "variables": { "additionalProperty": [ "example" ] }, "widget_ids": [ "example" ], "max_points": 1}Responses
Section titled “ Responses ”One result per widget, in the order asked
Media type application/json
object
now
required
string format: date-time
results
required
Array<object>
object
id
required
string
status
required
string
error
string | null
window
approximate
required
boolean
warnings
required
Array<string>
data
One of:
null
One of:
object
partial_from
string | null format: date-time
series
required
Array<object>
object
id
required
The query or formula id.
string
label
required
string
group
required
object
key
additional properties
string
unit
required
string
compare
required
boolean
hidden
required
boolean
points
required
Array<Array<number>>
events
required
Array<object>
object
kind
required
string
id
required
string
title
required
string
severity
string | null
start
required
string format: date-time
end
string | null format: date-time
monitor_id
string | null format: uuid
kind
required
string
object
values
required
Array<object>
object
id
required
string
label
required
string
unit
required
string
value
number | null format: double
previous
number | null format: double
sparkline
array | null
kind
required
string
object
group_by
required
Array<string>
columns
required
Array<object>
object
id
required
string
label
required
string
unit
required
string
rows
required
Array<object>
object
group
required
object
key
additional properties
string
labels
required
object
key
additional properties
string
values
required
object
key
additional properties
number | null format: double
sparklines
object
total_groups
required
integer format: int32
kind
required
string
object
items
required
Array<object>
object
id
required
string format: uuid
name
required
string
type
required
string
status
required
string
url
string | null
tags
required
Array<string>
uptime
number | null format: double
response_time_ms
number | null format: double
last_checked_at
string | null format: date-time
regions_down
required
Array<string>
kind
required
string
object
counts
required
object
up
required
integer format: int32
down
required
integer format: int32
degraded
required
integer format: int32
paused
required
integer format: int32
pending
required
integer format: int32
total
required
integer format: int32
items
required
Array<object>
object
id
required
string format: uuid
name
required
string
type
required
string
status
required
string
url
string | null
tags
required
Array<string>
uptime
number | null format: double
response_time_ms
number | null format: double
last_checked_at
string | null format: date-time
regions_down
required
Array<string>
kind
required
string
object
days
required
integer format: int32
items
required
Array<object>
object
id
required
string format: uuid
name
required
string
type
required
string
uptime
number | null format: double
days
required
Array<object>
object
date
required
YYYY-MM-DD in the request timezone.
string
uptime
number | null format: double
downtime_seconds
integer | null format: int64
kind
required
string
object
items
required
Array<object>
object
id
required
string format: uuid
title
required
string
severity
required
string
status
required
string
created_at
required
string format: date-time
acknowledged_at
string | null format: date-time
resolved_at
string | null format: date-time
monitor_count
required
integer format: int32
kind
required
string
object
items
required
Array<object>
object
kind
required
string
monitor_id
required
string format: uuid
monitor_name
required
string
domain
required
string
expires_at
string | null format: date-time
days_left
integer | null format: int64
status
required
string
kind
required
string
object
items
required
Array<object>
object
timestamp
required
RFC 3339 with nanoseconds as stored.
string
level
required
string
message
required
string
source
string | null
host
string | null
env
string | null
version
string | null
trace_id
string | null
kind
required
string
object
items
required
Array<object>
object
trace_id
required
string
root_service
required
string
root_operation
required
string
start
required
string format: date-time
duration_ms
required
number format: double
span_count
required
integer format: int32
error_count
required
integer format: int32
kind
required
string
object
items
required
Array<object>
object
vital
required
string
p75
number | null format: double
good
required
integer format: int64
needs_improvement
required
integer format: int64
poor
required
integer format: int64
samples
required
integer format: int64
kind
required
string
Example
{ "results": [ { "status": "ok", "data": { "series": [ { "unit": "ms" } ], "events": [ { "kind": "incident" } ], "kind": "timeseries" } } ]}A widget, time range or variable value the link does not offer
The link is not available
Too many requests
Internal server error