Skip to main content
POST
Run dashboard panel

Restrictions

Usage

  • Executes every query of one panel of the current stored dashboard against its datasource. The call returns HTTP 200 even when every query failed; read run_state and each ref’s state and error.
  • Omitting revision (or sending 0) runs the current revision. Sending it makes the call fail with DashboardRevisionConflict (HTTP 409) when the dashboard has changed, instead of returning data for a stale definition.
  • run_state summarizes the refs: success when all succeeded, partial when at least one succeeded and at least one did not, and otherwise cancelled, incompatible or error. A ref is incompatible when its query ran but the result does not fit the panel’s visualization, for example a configured value field is missing or not numeric.
  • Each ref’s execution is datasource-specific and passed through unmodified; child_request_id identifies the underlying datasource call. Text panels cannot be run (HTTP 400), and an unknown panel_id returns TargetNotFound (HTTP 404).
  • max_data_points defaults to 100 and is bounded at 2–5000. At most 6 queries of one panel run at the same time. A response larger than 8 MiB is rejected with EntityTooLarge (HTTP 413) instead of being truncated. The call has a 35-second overall deadline; exceeding it returns RuntimeTimeout (HTTP 504).

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Execute one panel of a stored dashboard. Omit revision (or send 0) to run the current revision; send it to have a stale call rejected. Text panels cannot be run.

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

ID of the panel to execute. It must belong to the dashboard, otherwise the call returns TargetNotFound (HTTP 404).

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.

revision
integer<uint64>

Revision guard. When set (non-zero) it must equal the dashboard's current revision, otherwise the call fails with DashboardRevisionConflict (HTTP 409). Omit or send 0 to skip the check.

variables
object

Selections keyed by variable name, at most 20 entries. Variables without an entry fall back to their stored defaults; a name the dashboard does not define fails the call with HTTP 400.

max_data_points
integer | null

Target maximum number of points per series for range queries; the server derives the query step from it. 2–5000; omit or send null for the 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

Panel execution result. HTTP 200 is returned even when every query failed; read run_state and each ref's state and error. A response larger than 8 MiB is rejected with EntityTooLarge (HTTP 413) instead of being truncated.