| Field | Type | Required | Description | Example |
|---|---|---|---|---|
partner_id |
T.nilable(::String) | ➖ | The ID of the partner to retrieve analytics for. | |
tenant_id |
T.nilable(::String) | ➖ | The ID of the tenant that created the link inside your system. | |
interval |
T.nilable(::OpenApiSDK::Operations::RetrievePartnerAnalyticsQueryParamInterval) | ➖ | The interval to retrieve analytics for. If undefined, defaults to 24h. | |
start |
T.nilable(::String) | ➖ | The start date and time when to retrieve analytics from. Takes precedence over interval. |
|
end_ |
T.nilable(::String) | ➖ | The end date and time when to retrieve analytics from. If not provided, defaults to the current date. Takes precedence over interval. |
|
timezone |
T.nilable(::String) | ➖ | The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC. | America/New_York |
group_by |
T.nilable(::OpenApiSDK::Operations::QueryParamGroupBy) | ➖ | The parameter to group the analytics data points by. Defaults to count if undefined. |
|
program_id |
::String | ✔️ | The ID of the program to retrieve analytics for. |