APPS_V2

Query Dataset Endpoint

Run a dataset query and return the engine's column/row envelope.

timezone (from the x-timezone header, default "UTC") buckets any granularity-based trend in the caller's timezone, matching v1's GET /warehouse/cost/v2/ — see apps.engine.sql_builder.SqlBuilder.date_trunc for how it stays a bound parameter rather than an interpolated value.

post/api/v2/datasets/{name}/query

Path parameters

namestring required

Headers

x-tenantstring required
x-user-group-idstring nullable
x-timezonestring nullable

Request body

filtersobject
start_datestring date required
end_datestring date required
granularity'day' | 'week' | 'month'
limitinteger
searchstring nullable
pageinteger
sizeinteger

Response

Successful Response

rowsobject[] required

Changes

Changed in 3 of the 55 revisions of this API.3

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      endpoint added

      endpoint-added