Skip to content

analytics_dashboard_update

Change fields of a saved dashboard of the current product.

Tool

analytics_dashboard_update

Change fields of a saved dashboard of the current product.

Change fields of a saved dashboard of the current product. Only the fields supplied are changed; the rest keep their stored values. Supplying tiles replaces the whole arrangement, so send the tiles you want to keep along with the new ones. The slug cannot be changed — create a new dashboard instead.

Behavior

HTTP
PATCH /analytics/dashboards/:id

Arguments

NameTypeRequiredDescription
idstringThe dashboard's uuid; slugs are not accepted here
namestringNo description in the catalog.
tagsarrayNo description in the catalog.
tilesarrayNo description in the catalog.

Response

FieldTypeAlwaysDescription
idstring
namestring
slugstring
tagsarray
tilesarray
created_atstring
created_bystring
product_idstring
updated_atstring

Try it

Change fields of a saved dashboard of the current product.

When to use

Change fields of a saved dashboard of the current product. Only the fields supplied are changed; the rest keep their stored values. Supplying tiles replaces the whole arrangement, so send the tiles you want to keep along with the new ones. The slug cannot be changed — create a new dashboard instead.

Example

Ask your agent something like this:

Change fields of a saved dashboard of the current product.

The agent will invoke analytics_dashboard_update with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect