Skip to main content
POST
Preview datasource query

Restrictions

Usage

  • ds_type must match the datasource type (e.g. prometheus, loki).
  • ds_name is the display name of the datasource as configured in the account.
  • delay_seconds shifts the query window backward by the specified number of seconds, useful for accommodating data ingestion latency.
  • The response body is the raw JSON returned by the datasource — its schema varies by datasource type.

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

Parameters for a synchronous datasource query preview.

ds_type
string
required

Datasource type, e.g. prometheus, loki, elasticsearch.

ds_name
string
required

Datasource display name as configured in the account.

expr
string
required

Query expression. Format depends on ds_type (PromQL for Prometheus, LogQL for Loki, etc.).

delay_seconds
integer

Shift the query window backward by this many seconds to compensate for data ingestion latency.

args
object

Additional datasource-type-specific query arguments (string keys and values), e.g. sls.project and sls.logstore for SLS, es.type for Elasticsearch, loki.type and loki.limit for Loki.

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

Raw JSON response from the datasource. Schema varies by datasource type.