| Field | Type | Required | Description | Example |
|---|---|---|---|---|
partner_id |
OptionalNullable[str] | ➖ | The ID of the partner to create a link for. Will take precedence over tenantId if provided. |
|
tenant_id |
OptionalNullable[str] | ➖ | The ID of the partner in your system. If both partnerId and tenantId are not provided, an error will be thrown. |
|
interval |
Optional[operations.RetrievePartnerAnalyticsQueryParamInterval] | ➖ | The interval to retrieve analytics for. If undefined, defaults to 24h. | |
start |
Optional[str] | ➖ | The start date and time when to retrieve analytics from. If set, takes precedence over interval. |
|
end |
Optional[str] | ➖ | 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. |
|
timezone |
Optional[str] | ➖ | The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC. | America/New_York |
query |
Optional[str] | ➖ | Search the events by a custom metadata value. Only available for lead and sale events. Examples: metadata['key']:'value' |
|
group_by |
Optional[operations.RetrievePartnerAnalyticsQueryParamGroupBy] | ➖ | The parameter to group the analytics data points by. Defaults to count if undefined. |