Skip to main content
POST
Query dataset data
Use this route for runtime variables, field filters, a timezone, or refresh: true. Filters run after joins and dataset transformations. Variables and source refreshes require the Refresh data from sources key permission.

Authorizations

Authorization
string
header
required

A database-bound Data API key created in Team settings. Session and share tokens are not accepted.

Path Parameters

team_id
integer
required

Positive team ID bound to the API key.

Required range: x >= 1
dataset_id
integer
required

Positive dataset ID.

Required range: x >= 1

Body

application/json
variables
object

Runtime variable values. The default limit is 100 keys, 10 nested levels, and 8192 bytes per string. Variable names proto, constructor, and prototype are not accepted.

filters
object[]

Chart-wide field filters. Date and chart dataset configuration scopes are not accepted.

Maximum array length: 50
refresh
boolean
default:false
timezone
string
default:UTC

IANA timezone used for dataset field comparisons.

Example:

"Asia/Bangkok"

Response

Joined and transformed dataset data.

version
enum<integer>
required
Available options:
1
generatedAt
string<date-time>
required
resource
object
required
fields
object[]
required
data
any | null
required

Joined and transformed dataset value. It can be an array, object, scalar, or null.