analytics_insight_create

Tool

analytics_insight_create

Save a named insight for the current product: one to eight series over the analytics semantic layer, an optional formula combining them by key, a time window and how to display it.

Save a named insight for the current product: one to eight series over the analytics semantic layer, an optional formula combining them by key, a time window and how to display it. The slug is the address the insight is read by and cannot be changed later. Stores the definition only; it does not run it. Series requests are validated with the same schemas analytics_metric_query and analytics_funnel_run accept, so a stored insight always runs.

Behavior

HTTP: POST /analytics/insights

Arguments

Name	Type	Required	Description
kind	string	•	No description in the catalog.
name	string	•	No description in the catalog.
slug	string	•	No description in the catalog.
tags	array	—	No description in the catalog.
grain	string	—	No description in the catalog.
series	array	•	No description in the catalog.
target	object	—	No description in the catalog.
window	object	•	No description in the catalog.
display	string	—	No description in the catalog.
formula	string	—	No description in the catalog.
description	string	—	No description in the catalog.

Response

Field	Type	Always
id	string	•
kind	string	•
name	string	•
slug	string	•
tags	array	—
grain	string	—
series	array	•
target	object	—
window	object	•
display	string	—
formula	string	—
created_at	string	•
created_by	string	•
product_id	string	•
updated_at	string	•
description	string	—

Try it

Save a named insight for the current product: one to eight series over the analytics semantic layer, an optional formula combining them by key, a time window and how to display it.

When to use

Example

Ask your agent something like this:

Save a named insight for the current product: one to eight series over the analytics semantic layer, an optional formula combining them by key, a time window and how to display it.

The agent will invoke analytics_insight_create with these arguments:

{
  "kind": "<kind>",
  "name": "<name>",
  "slug": "<slug>",
  "series": "<series>",
  "window": "<window>"
}