Business Intelligence

Build a dashboard from a description

Builds a NEW dashboard from what the person described — its name and its charts (widgets) — and saves it PRIVATE to them: nobody else sees it, and no tool can share it (they do that themselves, from the board in the app). Each widget measures one dataset grouped by one of its dimensions, so discover them first: custodo_query_analytics with no arguments lists every dataset you may chart, with its dimensions, splits and filters — copy those keys exactly. Chart shapes follow the axis: grouped by time line/area/column/bar/table/stat, by anything else column/bar/donut/table/stat, a one-number dataset stat/column/bar/table; omit viz for the first. A dataset whose windowed is false measures the present and takes no range and no compare. At most 24 widgets, and 20 boards per person — the organisation’s plan may allow fewer. Whatever the catalogue does not offer you is refused with the valid choices, and nothing is saved. Returns the board id and open_in_web: give the person the link, and read the numbers with bi_run_dashboard.

post/api/v1/rest/bi/dashboards

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/bi/dashboards
  • Auth: HTTP bearer

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Request body

namestring required

The board’s name, in the person’s words.

range'last_7_days' | 'last_30_days' | 'last_90_days' | 'last_12_months' | 'this_month' | 'this_year' | 'all_time' | 'custom'

One window for the whole board, over each widget’s own. Omit to leave each its own.

fromstring nullable

With range "custom" only.

tostring nullable

With range "custom" only.

filtersobject

Board-wide filters: each narrows every widget whose dataset declares that key.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

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