Business Intelligence

Change one of your dashboards

Changes one of YOUR OWN dashboards (mine: true in bi_list_dashboards), and only the change the person asked for. Send only what changes: name; add_widgets to append charts; or widgets for the COMPLETE new list — read the board with bi_get_dashboard first, keep each widget that stays with { keep_widget: "<its id>" } (plus any field to change on it, such as viz or range), and leave out the ones to remove; and the board-wide range and filters. New and changed widgets are checked exactly as bi_create_dashboard checks them. A colleague’s board that you can read stays theirs: offer to build the person their own with bi_create_dashboard. Never changes who can see a board. A widget the board already shows is not appended twice, so a retry is safe.

patch/api/v1/rest/bi/dashboards/{id}

Request

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

Path parameters

idstring uuid required

One of YOUR boards (mine: true in 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.

Request body

namestring

A new name.

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

One window for the whole board; null gives each widget its own again.

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.