analytics_dashboard_run

Tool

analytics_dashboard_run

Run every tile of a saved dashboard of the current product and return one entry per tile, in board order: the tile itself, and what it produced.

Run every tile of a saved dashboard of the current product and return one entry per tile, in board order: the tile itself, and what it produced. An insight tile carries exactly what analytics_insight_run answers for that insight; a text tile carries a null result, because its content is the tile. `from` and `to` override the window of every insight tile for this call only, changing nothing stored. A tile that fails carries an error with an HTTP status and does not stop the rest of the board, so check each tile's result before reading numbers.

Behavior

HTTP: POST /analytics/dashboards/:idOrSlug/run

Arguments

Name	Type	Required	Description
to	string	—	Inclusive window end; overrides the stored window
from	string	—	Inclusive window start; overrides the stored window
idOrSlug	string	•	The dashboard's slug, or its uuid

Response

Field	Type	Always	Description
tiles	array	•
dashboard	object	•

Try it

Run every tile of a saved dashboard of the current product and return one entry per tile, in board order: the tile itself, and what it produced.

When to use

Example

Ask your agent something like this:

Run every tile of a saved dashboard of the current product and return one entry per tile, in board order: the tile itself, and what it produced.

The agent will invoke analytics_dashboard_run with these arguments:

{
  "idOrSlug": "<idOrSlug>"
}