Skip to main content
GET /api/v1/clicks — the raw click stream for your workspace, newest first, cursor-paginated. Scope: secret key (lk_).

Query parameters

limit
integer
default:"100"
Maximum clicks to return (max 500).
before
string (ISO 8601)
Cursor — return clicks strictly older than this timestamp. Pass the previous response’s next_cursor.
Restrict to a single link.
bots
string
Set bots=include to include bot traffic. By default bots are excluded.

Response

clicks
array
Each click: id, ts, link_id, visitor_id, channel, country, city, device, browser, os, referer, is_bot.
next_cursor
string | null
Pass back as before to fetch the next page. null means the end of the stream.
Use visitor_id from a click to fetch that visitor’s full journey, or join the stream to your own orders table to build a warehouse.