Skip to main content
POST
Run dashboard panel

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Execute one panel against the stored dashboard. Omit revision to run the current revision; send it to have stale responses rejected.

dashboard_id
string
required

Canonical UUIDv7 of the dashboard.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
panel_id
string
required

Panel to execute.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
time
object
required

Absolute evaluation window. Both bounds are Unix timestamps in milliseconds, from_ms must be less than to_ms, and neither may exceed the JavaScript safe integer limit.

variables
object
required

Selections keyed by variable name, at most 20 entries.

revision
integer<uint64>

Revision guard; when set it must equal the current revision.

Required range: x >= 1
max_data_points
integer | null

Downsampling target, 2–5000 points; omit or send null for the server default of 100.

Required range: 2 <= x <= 5000

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
required

Panel execution result. run_state aggregates the per-query states: success when all succeeded, partial when some did, otherwise incompatible, cancelled or error. The total response is capped at 8 MiB.