Skip to main content
GET
Scan and click analytics

Authorizations

Authorization
string
header
required

An API key (klk_...) or a Clerk session token. Both resolve to the same account and behave identically.

Path Parameters

id
string
required

The link id returned when the link was created.

Example:

"lnk_2YgQk1p8fT3mN7wCxRvBdLsHjZa"

Query Parameters

from
integer

Window start, epoch ms.

to
integer

Window end, epoch ms.

group_by
enum<string>
default:day

day (default), country, device or referrer.

Available options:
day,
country,
device,
referrer

Response

The series.

Recent buckets come from Analytics Engine and older ones from permanent rollups; the seam is at a UTC day boundary and is invisible to you.

from
integer
required

Start of the window, inclusive. Epoch milliseconds.

Example:

1755734400000

to
integer
required

End of the window, exclusive. Epoch milliseconds.

Example:

1755734400000

group_by
enum<string>
required
Available options:
day,
country,
device,
referrer
total
integer
required
series
object[]
required