ChartDataResponseSchema

dashboard_filters object

Metadata about dashboard native filters applied to the query. Only present when filters_dashboard_id is provided.

filters object[]

Metadata about each in-scope dashboard native filter and whether its default value was applied to the query

Array [

columnstringnullable

Target column name for the filter

idstringrequired

The native filter ID

namestringrequired

The native filter name

statusstringrequired

Filter status: 'applied' (default value was included in the query), 'not_applied' (filter had no default value and was omitted, matching dashboard initial-load behavior), or 'not_applied_uses_default_to_first_item_prequery' (filter uses defaultToFirstItem which requires a pre-query to resolve and cannot be applied server-side)

]

result object[]

A list of results for each corresponding query in the request.

Array [

annotation_dataobject[]nullable

All requested annotation data

applied_filtersobject[]

A list with applied filters

cache_keystringnullablerequired

Unique cache key for query object

cache_timeoutintegernullablerequired

Cache timeout in following order: custom timeout, datasource timeout, cache default timeout, config default cache timeout.

cached_dttmstringnullablerequired

Cache timestamp

colnamesstring[]

A list of column names

coltypesinteger[]

A list of generic data types of each column

dataobject[]

A list with results

detected_currencystringnullable

Detected ISO 4217 currency code when AUTO mode is used. Returns the currency code if all filtered data contains a single currency or null if multiple currencies are present.

Default value: null

errorstringnullable

Error

from_dttmintegernullable

Start timestamp of time range

is_cachedbooleanrequired

Is the result cached

queried_dttmstringnullablerequired

UTC timestamp when the query was executed (ISO 8601 format)

querystringnullable

The executed query statement. May be absent when validation errors occur.

rejected_filtersobject[]

A list with rejected filters

rowcountinteger

Amount of rows in result set

stacktracestringnullable

Stacktrace if there was an error

statusstring

Status of the query

Possible values: [stopped, failed, pending, running, scheduled, success, timed_out]

timing object

Optional versioned query lifecycle timing breakdown in milliseconds. Present only when CHART_DATA_INCLUDE_TIMING is enabled; disabled by default.

query objectrequired

cache_resolution_msnumbernullablerequired

data_acquisition_msnumbernullablerequired

payload_assembly_msnumbernullablerequired

query_planning_msnumbernullablerequired

total_msnumberrequired

versionintegerrequired

Possible values: [1]

to_dttmintegernullable

End timestamp of time range

warningstringnullable

Warning message when results were truncated

]

ChartDataResponseSchema

{
  "dashboard_filters": {
    "filters": [
      {
        "column": "string",
        "id": "string",
        "name": "string",
        "status": "string"
      }
    ]
  },
  "result": [
    {
      "annotation_data": [
        {}
      ],
      "applied_filters": [
        {}
      ],
      "cache_key": "string",
      "cache_timeout": 0,
      "cached_dttm": "string",
      "colnames": [
        "string"
      ],
      "coltypes": [
        0
      ],
      "data": [
        {}
      ],
      "detected_currency": null,
      "error": "string",
      "from_dttm": 0,
      "is_cached": true,
      "queried_dttm": "string",
      "query": "string",
      "rejected_filters": [
        {}
      ],
      "rowcount": 0,
      "stacktrace": "string",
      "status": "stopped",
      "timing": {
        "query": {
          "cache_resolution_ms": 0,
          "data_acquisition_ms": 0,
          "payload_assembly_ms": 0,
          "query_planning_ms": 0,
          "total_ms": 0
        },
        "version": 1
      },
      "to_dttm": 0,
      "warning": "string"
    }
  ]
}