Skip to main content
POST
links.short.clicks.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
endUserRef
string
required

Your own reference for the end user, 1 to 128 letters, digits, '_', '.' or '-'. Never an email or name.

Pattern: ^[A-Za-z0-9_.-]{1,128}$
ref
string
required

The ref returned by links.short.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
startDate
string

First day of the window, YYYY-MM-DD (UTC). Defaults to 29 days before endDate. At most 90 days inclusive.

Pattern: ^\d{4}-\d{2}-\d{2}$
endDate
string

Last day of the window, YYYY-MM-DD (UTC). Defaults to today.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

The result

totalClicks
integer
required

Total clicks in the window.

Required range: 0 <= x <= 9007199254740991
days
object[]
required

Clicks per day in the window. Totals only: no visitor-level data.