analytics_insight_get

Tool

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

Read one saved insight of the current product by its slug or its id. Returns the definition, not results.

Name	Type	Required	Description
idOrSlug	string	•	The insight's slug, or its uuid

Field	Type	Always	Description
id	string	•
kind	string	•
name	string	•
slug	string	•
sort	object	—	Pivot only: which column orders the rows, and the direction
tags	array	—
combo	object	—	Display combo only: which series draw as the line
grain	string	—
top_n	integer	—	Pivot only: rows kept, 1 to 50 (default 20); the rest are folded into other
series	array	•
target	object	—
window	object	•
display	string	—
formula	string	—
stacked	boolean	—	Display area or bar only: stack the series (or the groups of one grouped series); all in one unit. Defaults to false
formulas	array	—	Up to four named formulas over the series keys, each its own column or line; use instead of formula
created_at	string	•
created_by	string	•
product_id	string	•
rows_label	string	—	Pivot only: the title of the row-header column, 1 to 40 characters (e.g. Кампания)
updated_at	string	•
description	string	—
formula_label	string	—
formula_format	object	—	Display format for a raw value. kind percent means a fraction: 0.128 displays as 12.8%. Money stays raw at the declared scale; readers convert it for display with this format.

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

When to use

Read one saved insight of the current product by its slug or its id. Returns the definition, not results.

Ask your agent something like this:

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

The agent will invoke analytics_insight_get with these arguments:

{
  "idOrSlug": "<idOrSlug>"
}