Skip to content

analytics_dashboard_create

Save a named dashboard for the current product: up to forty tiles, each either a reference to a saved insight by its uuid (from analytics_insight_list) or a block of markdown, each placed on a twelve-column grid.

Tool

analytics_dashboard_create

Save a named dashboard for the current product: up to forty tiles, each either a reference to a saved insight by its uuid (from analytics_insight_list) or a block of markdown, each placed on a twelve-column grid.

Save a named dashboard for the current product: up to forty tiles, each either a reference to a saved insight by its uuid (from analytics_insight_list) or a block of markdown, each placed on a twelve-column grid. The slug is the address the dashboard is read by and cannot be changed later. Stores the arrangement only; it does not run it. Every insight a tile names must already exist in this product, so a stored dashboard always resolves.

Behavior

HTTP
POST /analytics/dashboards

Arguments

NameTypeRequiredDescription
namestringNo description in the catalog.
slugstringNo 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

Save a named dashboard for the current product: up to forty tiles, each either a reference to a saved insight by its uuid (from analytics_insight_list) or a block of markdown, each placed on a twelve-column grid.

When to use

Save a named dashboard for the current product: up to forty tiles, each either a reference to a saved insight by its uuid (from analytics_insight_list) or a block of markdown, each placed on a twelve-column grid. The slug is the address the dashboard is read by and cannot be changed later. Stores the arrangement only; it does not run it. Every insight a tile names must already exist in this product, so a stored dashboard always resolves.

Example

Ask your agent something like this:

Save a named dashboard for the current product: up to forty tiles, each either a reference to a saved insight by its uuid (from analytics_insight_list) or a block of markdown, each placed on a twelve-column grid.

The agent will invoke analytics_dashboard_create with these arguments:

{
  "name": "<name>",
  "slug": "<slug>",
  "tiles": "<tiles>"
}

Esc

Start typing to search the docs.

navigateselect