Execute Query

Execute a dynamic analytics query.

post/analytics/widgets/execute-query

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

pageinteger nullable

perPageinteger nullable

sortBystring nullable

sortDirection'asc' | 'desc' nullable

locationIdstring nullable

chartTypestring nullable

Chart type to optimize query behavior (table, bar, etc.)

searchstring nullable

Global search term to filter across text fields

tzstring required

Timezone for date filtering and temporal grouping

Successful Response

dataobject[] required

Query result data

totalCountinteger required

Total number of results

executionTimeMsnumber required

Query execution time in milliseconds

metadataobject nullable

Field metadata for chart rendering

No recorded changes to this endpoint across all 1 revision of this API.