Answer a dashboard’s questions
Runs a saved dashboard and returns its NUMBERS: per widget the unit, the total and up to row_limit buckets (50 at most, and the total always sums EVERY bucket, including those past the cut), all measured on one clock inside one transaction. Every widget is re-queried AS YOU — one whose module, permission or tier you lack comes back unavailable with the reason, and one whose provider failed comes back degraded, never as a zero, which is also why a colleague’s shared board can never leak a figure. At most 6 widgets per call: pass widgets to choose which, read bi_get_dashboard first to see what the board asks, and use custodo_query_analytics for a question nobody saved. Returns data, never layout — no chart type, no position, no colours.
Examples
- Give me the numbers from the «Direzione» dashboard GET /api/v1/rest/bi/dashboards/11111111-2222-4333-8444-555555555555/results
- Just the first two cards, for last month GET /api/v1/rest/bi/dashboards/11111111-2222-4333-8444-555555555555/results?widgets=w1&widgets=w2&range=this_month
- Read the board the way the «Milano» view reads it GET /api/v1/rest/bi/dashboards/11111111-2222-4333-8444-555555555555/results?view=Milano&response_format=detailed
Request
- Base URL: https://api.custodo.ai
- URL: https://api.custodo.ai/api/v1/rest/bi/dashboards/{id}/results
- Auth: HTTP bearer
Path parameters
The dashboard id, from bi_list_dashboards.
Query parameters
Which widgets to answer, by the ids bi_get_dashboard returns. Omit to answer the first 6 in board order — the answer names the ones it left out so you can ask for them in a second call.
A saved view to read the board through, by name. The answer lists the names this board has. Omit to read it as its author left it.
Override the window every widget is measured over. Use custom with from/to. Omit to keep each widget on the window it was saved with.
Read only when range is custom. A calendar day, not a timestamp.
Read only when range is custom.
Buckets per widget, 1–50. Each widget's own saved ceiling is clamped down to this. The total is always the sum over EVERY bucket, including those past the cut.
concise (default) returns the fields you need to answer a question; detailed adds related records and costs more context.
Headers
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.
Response
Done. data is the tool’s own answer.
Changes
No recorded changes to this operation across all 1 revision of this API.