Analytics › List a link’s clicks

Analytics

List a link’s clicks

GET/api/{ORG}/links/{link}/clicksPermalink

Newest first, 25 a page (?size=25|50). The next page's cursor is the x-next-cursor header: send it back as ?before=. A plan that keeps no click one by one answers an empty list.

Permission
Analytics · view
Plan
Plans that include the API: Pricing
Retry
Safe: a read changes nothing

Example request

bash
curl "https://console.brevily.com/api/NORTHWIND/links/01JC6Y8QH2M4ZK7T9VRW3XNB5D/clicks" \  -H "x-api-key: brv_ak_7Fq2Lw9xK3" \  -H "x-api-secret: $BREVILY_SECRET"

Example answer

json
[  {    "id": "01JC6Y8QH2M4ZK7T9VRW3XNB5D",    "clickedOn": "2026-11-05T09:41:00Z",    "source": "LINK",    "country": "example",    "device": "example",    "os": "example",    "browser": "example",    "referrer": "example",    "bot": false,    "routedBy": "example",    "destination": "https://www.example.com/sale/autumn"  }]

Made-up values.

Path parameters
NameTypeRequiredDescriptionAllowed values
ORGstringrequiredYour organisation’s code.3 to 20 characters
linkstringrequired—

A list of Click, one page at a time: paging.

Answer fields
NameTypeDescriptionAllowed values
idstringThe click’s id.—
clickedOndate-timeWhen it happened.—
sourcestringThe link itself, or its QR code.LINK, QR
countrystringThe visitor’s country code; null when unknown.or null
devicestringDESKTOP, MOBILE, TABLET, BOT or OTHER; null when unknown.or null
osstringThe operating system; null when unknown.or null
browserstringThe browser, or a crawler’s name; null when unknown.or null
referrerstringThe referrer’s origin; null for direct traffic.or null
botbooleanA known crawler.—
routedBystringThe rule or variant that routed it ("Rule 1 · Phones in India"); null for the link’s own destination.or null
destinationstringWhere it was sent.—
Errors
Status Code When
400 VALIDATION_FAILED A field, a parameter or the body is wrong; details.fields says which.
401 UNAUTHENTICATED No key, a key that does not match, or one expired or revoked.
403 ACCESS_DENIED The key lacks Analytics · view, or the organisation’s plan does not include it.
404 NOT_FOUND No organisation with that code for this key, or no such record in it.
429 RATE_LIMITED Too many calls: wait Retry-After seconds.

Counted with every other call of the organisation, by plan: Pricing. The answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; more on rate limits.