viewer_analytics_data
This endpoint retrieves viewer analytics data. This endpoint is use for deep insights on the analytics data.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "viewer_analytics_data"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filters | No | Build *segments* of users using multiple filters on the data, `value` should be an *exact match* | |
| metrics | No | Get data for one or more metrics in the same request. Supported values: `views`, `unique_views`, `impressions`, `completion_percent_by_views`, `playing_time`, `concurrent_users`, `widget_form_submitted`, and `cta_clicks`. | |
| download | No | Whether the request is to download the chart data | |
| group_by | No | Data can be grouped by `daily`, `weekly` or `monthly`. | daily |
| date_range | No | The timeframe to get the data for. The maximum range between start_at and end_at is 60 days. | |
| workspace_id | No | Gumlet workspace ID | |
| chart_dimension | No | Group metrics by the selected dimension. You can select up to 3 dimensions for nested category results; results follow the selection order. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||