Skip to main content
POST
Resolve dashboard variables

Restrictions

Usage

  • Resolves the variables of the current revision of a stored dashboard. variables holds the caller’s current selections; a variable without an entry falls back to its stored default (default for custom and query variables; for datasource variables the default_datasource_id if it is still a candidate, otherwise the first candidate ordered by name).
  • A variable that cannot be resolved does not fail the call: its entry carries an error and is left out of selections. Typical causes are no selection and no default, a selection that is not among the candidates, an unresolved dependency, or an unreachable datasource.
  • An explicitly empty values selection means unresolved (variable_invalid); the resolver does not fall back to the stored default.
  • Variables are resolved in dependency order, so a variable that depends on a failed variable also reports an error. A name in variables that the dashboard does not define fails the call with HTTP 400.
  • Each variable returns at most 1000 candidates, and all candidates together must fit in 8 MiB, otherwise the call fails with EntityTooLarge (HTTP 413). query variables can only run against Prometheus, MySQL and Loki datasources.
  • The caller must be able to see the dashboard’s folder; otherwise the call returns DashboardNotFound (HTTP 404). 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

Resolve every variable of a stored dashboard against a time range and the caller's current selections.

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}$
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

Selections already made, 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.

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

Resolved variables plus the effective selection for each name.