Skip to content

analytics_dashboard_get

Read one saved dashboard of the current product by its slug or its id.

Tool

analytics_dashboard_get

Read one saved dashboard of the current product by its slug or its id.

Read one saved dashboard of the current product by its slug or its id. Returns the tiles and their layout, not results.

Behavior

HTTP
GET /analytics/dashboards/:idOrSlug

Arguments

NameTypeRequiredDescription
idOrSlugstringThe dashboard's slug, or its uuid

Response

FieldTypeAlwaysDescription
idstring
namestring
slugstring
tagsarray
tilesarray
created_atstring
created_bystring
product_idstring
updated_atstring

Try it

Read one saved dashboard of the current product by its slug or its id.

When to use

Read one saved dashboard of the current product by its slug or its id. Returns the tiles and their layout, not results.

Example

Ask your agent something like this:

Read one saved dashboard of the current product by its slug or its id.

The agent will invoke analytics_dashboard_get with these arguments:

{
  "idOrSlug": "<idOrSlug>"
}

Esc

Start typing to search the docs.

navigateselect