Suggest analytics events to track

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns short prompts that suggest analytics events worth tracking in the app.

An AI model writes them from the app's name, description, and recent AI chat messages, so each call can return different prompts. The call doesn't use the workspace's credits. You usually get four prompts, in English. If the model can't be reached you get a fixed set of general prompts instead, with a successful response.

To add the tracking, put prefix in front of a prompt and send it with Send chat message. Once the app sends events, read them with List analytics event names.

This is limited to 30 requests a minute for each workspace's personal API keys, across all the workspace's apps, so every key in a workspace shares one allowance. Some workspaces have a different limit.

<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app. A read-only key is refused, and workspace API keys are not accepted.</Note>

get/api/apps/{app_id}/analytics/suggestions

Path parameters

app_idstring required

ID of the app whose analytics to read.

ID of the app whose analytics to read.

Response

Suggested prompts for the app.

suggestionsstring[] required

Short prompts, each describing events worth tracking in this app. They don't include prefix.

prefixstring required

Text to put in front of each prompt before you send it to the app's AI chat.

Example response

{
  "suggestions": [
    "Track recipe saves and shares",
    "Log meal plan creation",
    "Record grocery list exports",
    "Monitor search queries and result clicks"
  ],
  "prefix": "Using Event Tracking, "
}

Changes

Changed in 1 of the 22 revisions of this API.1

Of the 22 revisions, 1 has no diff computed.