Analytics API

Query click events, page views, and aggregate analytics programmatically. Filter by date range, group by dimensions, and export data for your own dashboards.

GET/v1/analytics/clicks

Query click events for your workspace with filtering and grouping.

Parameters

Name	Type	Required	Description
linkId	string	No	Filter by specific link ID
from	ISO 8601	No	Start date (default: 30 days ago)
to	ISO 8601	No	End date (default: now)
groupBy	string	No	Group results by: day, country, device, browser, referrer
limit	number	No	Max results to return (default: 100, max: 1000)

GET/v1/analytics/clicks/:linkId

Get detailed click analytics for a specific link.

Parameters

Name	Type	Required	Description
from	ISO 8601	No	Start date
to	ISO 8601	No	End date
groupBy	string	No	Group results by: day, country, device, browser, referrer

GET/v1/analytics/pages/:pageId

Get view analytics for a specific bio page.

Parameters

Name	Type	Required	Description
from	ISO 8601	No	Start date
to	ISO 8601	No	End date
groupBy	string	No	Group results by: day, referrer

GET/v1/analytics/summary

Get a high-level summary of workspace analytics.

Parameters

Name	Type	Required	Description
from	ISO 8601	No	Start date
to	ISO 8601	No	End date

Response Example

GET /v1/analytics/clicks?groupBy=day&from=2026-03-01

{
  "data": [
    { "date": "2026-03-01", "clicks": 1423 },
    { "date": "2026-03-02", "clicks": 1891 },
    { "date": "2026-03-03", "clicks": 2104 }
  ],
  "total": 5418,
  "from": "2026-03-01T00:00:00Z",
  "to": "2026-03-13T23:59:59Z"
}

Summary Response

GET /v1/analytics/summary

{
  "totalClicks": 48291,
  "totalPageViews": 12043,
  "totalLinks": 342,
  "totalPages": 18,
  "topCountries": ["US", "GB", "PK", "IN", "DE"],
  "topDevices": { "mobile": 58, "desktop": 38, "tablet": 4 },
  "period": { "from": "2026-02-13", "to": "2026-03-13" }
}