Retrieve analytics for a partner
Retrieve analytics for a partner within a program. The response type vary based on the groupBy
query parameter.
Partners endpoints require an Advanced plan subscription or higher.
Authorizations
Default authentication mechanism
Query Parameters
The ID of the partner to retrieve analytics for.
The ID of the tenant that created the link inside your system.
The interval to retrieve analytics for. If undefined, defaults to 24h.
24h
, 7d
, 30d
, 90d
, 1y
, mtd
, qtd
, ytd
, all
The start date and time when to retrieve analytics from. If set, takes precedence over interval
.
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
.
The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.
"America/New_York"
The parameter to group the analytics data points by. Defaults to count
if undefined.
top_links
, timeseries
, count
The ID of the program to retrieve analytics for.
Response
The total number of clicks
The total number of leads
The total number of sales
The total amount of sales, in cents
The total number of clicks
The total number of leads
The total number of sales
The total amount of sales, in cents
The starting timestamp of the interval
The number of clicks in the interval
The number of leads in the interval
The number of sales in the interval
The total amount of sales in the interval, in cents
The unique ID of the short link
The unique ID of the short link
The domain of the short link
The key of the short link
The short link URL
The destination URL of the short link
The creation timestamp of the short link
The number of clicks from this link
The number of leads from this link
The number of sales from this link
The total amount of sales from this link, in cents
The comments of the short link
The custom link preview title (og:title)