Skip to main content
POST
Error

Path Parameters

exploreId
string
required
projectUuid
string
required

Body

application/json
tableCalculations
object[]
required

Custom calculations to perform on query results

limit
number<double>
required

Maximum number of rows to return

sorts
object[]
required

Sort configuration for query results

filters
object
required

Filter rules to apply to the query

metrics
string[]
required

List of metric field IDs to include

dimensions
string[]
required

List of dimension field IDs to include

exploreName
string
required

The name of the explore to query

metadata
object
pivotDimensions
string[]

Dimension field IDs used as pivot columns (from chart's pivotConfig.columns). Used by row_total() to determine non-pivot dimensions for GROUP BY.

timezone
string

Timezone for date/time values (e.g., 'America/Los_Angeles', 'UTC')

dimensionOverrides
object

Override formatting options for existing dimensions

metricOverrides
object

Override formatting options for existing metrics

customDimensions
object[]

Custom dimensions defined inline

additionalMetrics
object[]

Custom metrics defined inline (ad-hoc metrics not in the dbt model)

usePreAggregateCache
boolean
pivotConfiguration
object
parameters
object

Construct a type with a set of properties K of type T

Response

Success

results
object
required
status
enum<string>
required
Available options:
ok