Retrieve analytics for a partner
retrieve_partner_analyticsFetch performance data for a specific partner in a program, grouped by count, top links, or timeseries, with optional date range, interval, and timezone filters.
Instructions
Retrieve analytics for a partner within a program. The response type vary based on the groupBy query parameter.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`. | |
| query | No | Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'` | |
| start | No | The start date and time when to retrieve analytics from. If set, takes precedence over `interval`. | |
| account | No | Exact configured private workspace profile label; not a tenant or provider account ID. | |
| group_by | No | The parameter to group the analytics data points by. Defaults to `count` if undefined. | count |
| interval | No | The interval to retrieve analytics for. If undefined, defaults to 24h. | |
| timezone | No | The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC. | UTC |
| tenant_id | No | The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown. | |
| partner_id | No | The ID of the partner to create a link for. Will take precedence over `tenantId` if provided. |