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
curl "https://console.brevily.com/api/NORTHWIND/links/01JC6Y8QH2M4ZK7T9VRW3XNB5D/clicks" \ -H "x-api-key: brv_ak_7Fq2Lw9xK3" \ -H "x-api-secret: $BREVILY_SECRET"const res = await fetch("https://console.brevily.com/api/NORTHWIND/links/01JC6Y8QH2M4ZK7T9VRW3XNB5D/clicks", { headers: { "x-api-key": "brv_ak_7Fq2Lw9xK3", "x-api-secret": process.env.BREVILY_SECRET, },});const answer = await res.json();Example answer
[ { "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" }]{ "code": "VALIDATION_FAILED", "message": "Check the form. (root): Not a value this field takes.", "details": { "fields": { "(root)": "Not a value this field takes." } }, "requestId": "18188559082372202519"}Made-up values.
PathPermalink
| Name | Type | Required | Description | Allowed values |
|---|---|---|---|---|
ORG | string | required | Your organisation’s code. | 3 to 20 characters |
link | string | required | — |
AnswerPermalink
A list of Click, one page at a time: paging.
| Name | Type | Description | Allowed values |
|---|---|---|---|
id | string | The click’s id. | — |
clickedOn | date-time | When it happened. | — |
source | string | The link itself, or its QR code. | LINK, QR |
country | string | The visitor’s country code; null when unknown. | or null |
device | string | DESKTOP, MOBILE, TABLET, BOT or OTHER; null when unknown. | or null |
os | string | The operating system; null when unknown. | or null |
browser | string | The browser, or a crawler’s name; null when unknown. | or null |
referrer | string | The referrer’s origin; null for direct traffic. | or null |
bot | boolean | A known crawler. | — |
routedBy | string | The rule or variant that routed it ("Rule 1 · Phones in India"); null for the link’s own destination. | or null |
destination | string | Where it was sent. | — |
ErrorsPermalink
| 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. |
Rate limitsPermalink
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.
Type a call, a field or a guide.