analytics_dashboard_tile-run

Tool

analytics_dashboard_tile-run

Run one tile of a saved dashboard of the current product, by the tile's id (from analytics_dashboard_get), and return that tile's entry: the tile itself and what it produced — the same entry analytics_dashboard_run gives that tile for the same body. Takes the same `from`, `to`, `filters` and `compare` ("previous_period", "previous_week" or {from, to}; to compare yesterday with today, from and to today with compare {from: yesterday, to: yesterday}) as analytics_dashboard_run, checked against the whole board the same way (a filter key the board does not declare is a 400), and a funnel takes a filter on its first step only, exactly as there. Use it to fill a heavy board in progressively, one call per tile, keeping at most about 6 calls in flight per board (as many as analytics_dashboard_run runs at once). A text tile carries a null result; a tile that fails carries an error with an HTTP status rather than failing the call; a tile id the board does not have is a 404.

Behavior

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

Arguments

Name	Type	Required	Description
to	string	—	Inclusive window end; overrides the stored window
from	string	—	Inclusive window start; overrides the stored window
tileId	string	•	The tile's id, as analytics_dashboard_get returns it
compare	string	—	Also read a second range; each insight tile then carries `compare`, whose `window` is the exact range read. "previous_period": as many days as have elapsed of this window, ending the day before it starts. "previous_week": the same days one week earlier. {from, to}: any range of up to 366 whole UTC days (YYYY-MM-DD, inclusive), clipped to today; it may overlap this window
filters	object	—	Values for the dashboard's filters, by filter key: a filter without its dimension, e.g. {"country": {"op": "eq", "value": "DE"}}. A key the dashboard does not declare is a 400
idOrSlug	string	•	The dashboard's slug, or its uuid

Response

Field	Type	Always	Description
tile	object	•
result	object	•

Try it

Run one tile of a saved dashboard of the current product, by the tile's id (from analytics_dashboard_get), and return that tile's entry: the tile itself and what it produced — the same entry analytics_dashboard_run gives that tile for the same body.

When to use

Example

Ask your agent something like this:

Run one tile of a saved dashboard of the current product, by the tile's id (from analytics_dashboard_get), and return that tile's entry: the tile itself and what it produced — the same entry analytics_dashboard_run gives that tile for the same body.

The agent will invoke analytics_dashboard_tile-run with these arguments:

{
  "tileId": "<tileId>",
  "idOrSlug": "<idOrSlug>"
}