Skip to main content
GET
/
partners
/
analytics
Python
from dub import Dub


with Dub(
    token="DUB_API_KEY",
) as d_client:

    res = d_client.partners.analytics(request={
        "timezone": "America/New_York",
        "query": "metadata['key']:'value'",
    })

    # Handle response
    print(res)
{
  "clicks": 0,
  "leads": 0,
  "sales": 0,
  "saleAmount": 0,
  "earnings": 0
}
Partners endpoints require an Advanced plan subscription or higher.

Authorizations

​
Authorization
string
header
required

Query Parameters

​
partnerId
string | null
​
tenantId
string | null
​
interval
enum<string>
Available options:
24h,
7d,
30d,
90d,
1y,
mtd,
qtd,
ytd,
all
​
start
string
​
end
string
​
timezone
string
default:UTC
Example:
​
query
string
Maximum length: 10000
Example:
​
groupBy
enum<string>
default:count
Available options:
top_links,
timeseries,
count

Response

  • PartnerAnalyticsCount · object
  • PartnerAnalyticsTimeseries · object[]
​
clicks
number
default:0
required
​
leads
number
default:0
required
​
sales
number
default:0
required
​
saleAmount
number
default:0
required
​
earnings
number
default:0
required