Query Semantic Model

Beta
Execute a metric query against a semantic model. Specify measures, optional dimensions, filters, and time dimensions. Returns structured data rows.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

asset_idstringRequired

Request

This endpoint expects an object.
measureslist of stringsRequired

List of measure identifiers, e.g. [“orders.total_revenue”]

dimensionslist of strings or nullOptional
Optional dimension identifiers for grouping
filterslist of maps from strings to any or nullOptional
Optional filters
limitintegerOptional1-5000Defaults to 100

Maximum rows to return (default 100). When the result was cut at this limit the response sets “truncated”: true.

orderlist of lists of strings or nullOptional

Optional ordering as [member, direction] pairs applied before “limit”, e.g. [[“orders.count”, “desc”]] for a server-side top-N. Direction must be “asc” or “desc”.

time_dimensionslist of maps from strings to any or nullOptional
Optional time dimension configs

Response

Successful Response
datalist of maps from strings to any
Query result rows
row_countinteger
Number of rows returned
elapsed_msintegerOptionalDefaults to 0

Server-side execution time in milliseconds (semantic layer + engine, excluding network) — surface it to show how fast the engine answered

truncatedbooleanOptionalDefaults to false

True when the query produced more rows than ‘limit’ and the result was cut; raise ‘limit’ or add filters to see the rest

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
502
Bad Gateway Error