Business Intelligence

Read a dashboard’s saved questions (status)

Polling snapshot: the same current record or collection as the corresponding read endpoint, including its state and progress. List filters, defaults and pagination also apply here. This is not an event history or a changes-since feed. Poll at a sensible interval (start with 30 seconds), respect Retry-After on 429 and stop when the required terminal state is reached.

Returns what a dashboard MEASURES: for each widget its id, the dataset, the axis it groups by, its filters and its time window. It does NOT return the numbers — call bi_run_dashboard with the same dashboard id for those, and pass the widget ids from here when you only want some of them. Every figure is re-checked there against what you are allowed to see, which is why a widget may come back unavailable on a colleague’s shared dashboard.

Examples

  • What does the «Direzione» dashboard actually measure? GET /api/v1/rest/bi/dashboards/11111111-2222-4333-8444-555555555555/status
get/api/v1/rest/bi/dashboards/{id}/status

Request

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

Path parameters

idstring uuid required

From bi_list_dashboards.

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.

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.