Skip to content

Documentation

Analytics

Every click of every link is counted at the edge: the time, the country, the referring host, a coarse device class and whether it was a QR scan. No IP addresses or user agents are stored, link previews and crawlers are not counted, and a refresh loop counts at most ten times a minute per network per link.

  • GET /v1/links/{link}/stats is one link; GET /v1/stats is every link in the account summed, with the busiest links listed.
  • days is the range back from today in UTC, today included. Free shows up to 30 days; Pro shows up to 365. A larger value is quietly capped, and max_days in the answer tells you where.
  • days in the answer has one row per UTC day with at least one click, with its scans; zero-fill the gaps yourself. hours (clicks by hour of the UTC day) is present on plans with time-of-day analytics.
  • countries, referrers and devices are the top ten each; direct means no referrer.
  • GET /v1/links/{link}/clicks and GET /v1/clicks export the rows themselves, newest first: JSON in pages of 5,000 (follow next_before), or the whole range as a CSV file with format=csv. Exports are a Pro feature; other plans get 403 forbidden with details.upgrade.

Back to getting started