Skip to main content
POST
Preview draft variables

Restrictions

Usage

  • Resolves a draft variable list that is not stored in a dashboard, so an editor can test variables before saving. Nothing is persisted, so the response has no dashboard_id or revision.
  • context.kind is existing with dashboard_id when the draft belongs to a stored dashboard, or new with folder_id when the dashboard does not exist yet; sending the other kind’s field fails validation (HTTP 400). The caller needs access to that dashboard’s folder or to that folder (otherwise 403/404).
  • The draft variables are validated like a stored definition (names, dependencies, option limits, at most 20 variables, 1 MiB); a violation fails the call with HTTP 400, or HTTP 413 when a size limit is exceeded.
  • Resolution behaves like variable resolve: a variable that fails carries an error and is absent from selections, and an empty values selection is unresolved.
  • 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 a draft set of variables that is not stored in any dashboard yet.

context
object
required

Where an unsaved draft panel or variable set belongs. existing targets a stored dashboard, new a folder that does not contain one yet — the two are mutually exclusive.

variables
object[]
required

Draft variables, at most 20. They are validated like a stored definition (names, dependencies, option limits) and must stay within 1 MiB.

Maximum array length: 20

A dashboard variable. Pick the arm with kind.

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.

selections
object

Selections keyed by variable name, at most 20 entries. Variables without an entry fall back to their draft default; a name that is not in variables 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 draft variables. There is no dashboard_id because nothing is persisted.