Skip to content

analytics_insight_get

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

Tool

analytics_insight_get

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.

Behavior

HTTP
GET /analytics/insights/:idOrSlug

Arguments

NameTypeRequiredDescription
idOrSlugstringThe insight's slug, or its uuid

Response

FieldTypeAlwaysDescription
idstring
kindstring
namestring
slugstring
tagsarray
grainstring
seriesarray
targetobject
windowobject
displaystring
formulastring
created_atstring
created_bystring
product_idstring
updated_atstring
descriptionstring

Try it

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.

Example

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>"
}

Esc

Start typing to search the docs.

navigateselect