Skip to main content
GET
Get analytics for a link

Authorizations

Authorization
string
header
required

Clerk tenant API key. The organizationId encoded by the key is the exact and only tenant scope.

Path Parameters

Query Parameters

event
enum<string>
default:clicks
Available options:
clicks,
leads,
sales,
composite
groupBy
enum<string>
default:timeseries
Available options:
count,
timeseries,
top_links,
top_urls,
referers,
referer_urls,
countries,
regions,
cities,
devices,
browsers,
os,
utm_sources,
utm_mediums,
utm_campaigns
interval
enum<string>
default:30d

Preset interval used only when start is omitted.

Available options:
24h,
7d,
30d,
90d,
1y,
mtd,
qtd,
ytd,
all
start
string

Inclusive UTC date or timestamp. Overrides interval.

end
string

Inclusive UTC date or timestamp; requires start.

Response

Tenant-scoped resource.

event
enum<string>
required
Available options:
clicks,
leads,
sales,
composite
groupBy
enum<string>
required
Available options:
count,
timeseries,
top_links,
top_urls,
referers,
referer_urls,
countries,
regions,
cities,
devices,
browsers,
os,
utm_sources,
utm_mediums,
utm_campaigns
range
object
required
data
object
required

Sanitized count or grouped rows. Count fields and saleAmountCents are integers; provider configuration and internal link fields are excluded.