Sign in
Dashboards

Query Ad-hoc Widget Data

Computes widget data from a widget definition supplied inline, without creating a dashboard or saving a widget. Returns the same data shape as the dashboard widget query. Scoped to the project of the API key. At most 20 lines and a topK.limit of 100 are allowed, and an explicit query range may not exceed 366 days.

post/v1/widgets/query

Request body

startTimestring date-time

ISO 8601 start time for the query range. Must be provided with endTime.

endTimestring date-time

ISO 8601 end time for the query range. Must be provided with startTime.

granularity'thirty_minutes' | 'hour' | 'day' | 'week' | 'month'

Bucket size for computed widget data.

Response

The computed data for the supplied widget.

successboolean required

Indicates if the request was successful.

deprecatedboolean required

Indicates if this endpoint is deprecated.

Changes

Changed in 1 of the 54 revisions of this API.1

Of the 54 revisions, 3 have no diff computed.