Describe a dashboard widget

Turns a description such as "high-risk trips by country" into dashboard widget builder settings (visualization, measure, group, range, filters, table columns or measures) and a heading. The model may only use the builder values; a reply outside them is retried once, then the reason is returned as error. To refine a widget, send its current settings in current and the earlier requests in history; only what the new request asks for changes. A request the builder cannot express comes back as unsupported with a short reason, and no settings.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 500
current
object

The settings to refine: the widget a previous call returned.

history
array of strings
length ≤ 10

Earlier requests about this widget, oldest first.

history
date

The viewer's date, which relative requests such as "last month" are read from. Defaults to the server's UTC date.

string
enum

Where the builder runs. On report (a report page) the heading and replies call it a report, not a widget. Defaults to dashboard.

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json