get_partner_audience_stats
Retrieve detailed partner audience analytics, including unique visitors, commercial engagement, and geographic insights, by specifying a partner ID and time period. Supports grouped stats for device, referral, and location breakdowns.
Instructions
Get partner audience analytics including unique visitors, commercial visitors, and geographic data
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| includeGroupedStats | No | Include geographic, device, and referral breakdowns | |
| partnerId | Yes | Partner ID to get audience analytics for | |
| period | No | Time period for audience data | FOUR_WEEKS |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"includeGroupedStats": {
"default": true,
"description": "Include geographic, device, and referral breakdowns",
"type": "boolean"
},
"partnerId": {
"description": "Partner ID to get audience analytics for",
"type": "string"
},
"period": {
"default": "FOUR_WEEKS",
"description": "Time period for audience data",
"enum": [
"FOUR_WEEKS",
"SIXTEEN_WEEKS",
"ONE_YEAR"
],
"type": "string"
}
},
"required": [
"partnerId"
],
"type": "object"
}