API ReferenceSemantic Model

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
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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
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

Errors

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