Skip to content

analytics_insight_update

Change fields of a saved insight of the current product.

Tool

analytics_insight_update

Change fields of a saved insight of the current product.

Change fields of a saved insight of the current product. Only the fields supplied are changed; the rest keep their stored values. The slug cannot be changed — create a new insight instead.

Behavior

HTTP
PATCH /analytics/insights/:id

Arguments

NameTypeRequiredDescription
idstringThe insight's uuid; slugs are not accepted here
kindstringNo description in the catalog.
namestringNo description in the catalog.
tagsarrayNo description in the catalog.
grainstringNo description in the catalog.
seriesarrayNo description in the catalog.
targetobjectNo description in the catalog.
windowobjectNo description in the catalog.
displaystringNo description in the catalog.
formulastringNo description in the catalog.
descriptionstringNo description in the catalog.

Response

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

Try it

Change fields of a saved insight of the current product.

When to use

Change fields of a saved insight of the current product. Only the fields supplied are changed; the rest keep their stored values. The slug cannot be changed — create a new insight instead.

Example

Ask your agent something like this:

Change fields of a saved insight of the current product.

The agent will invoke analytics_insight_update with these arguments:

{
  "id": "<id>"
}

Esc

Start typing to search the docs.

navigateselect