Sign in
latestOpenAPI 3.0.02026-08-202629123.8 KB

351c1f004617

Clicks

Get click analytics

Retrieve click analytics for a workspace. Filter by link, date range, country, and more. Returns time-series data suitable for charting.

get/api/v1/workspace/{workspace_id}/clicks

Path parameters

workspace_idstring required

The id of the Workspace

Query parameters

link_idstring

The id of a single Link

link_idsstring

Filter clicks by multiple links. Provide a hyphen-separated list of link IDs.

startstring

The start date for the date range (format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ)

endstring

The end date for the date range (format: YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ)

countrystring

Filter clicks by country using ISO 3166-1 alpha-2 country code e.g US

browserstring

Filter clicks by browser name e.g Chrome, Firefox, Safari

platformstring

Filter clicks by platform/operating system e.g Windows, Mac, iOS, Android

refererstring

Filter clicks by referrer domain

ispstring

Filter clicks by Internet Service Provider name

botsboolean

Set to false to exclude bot clicks from the results

uniqueboolean

Set to true to only include unique clicks in the results

format'json' | 'csv' | 'tsv'

Specify the format of the response. Available options are 'json' (default), 'csv', or 'tsv'.

pivot'link_id'

Return data as a matrix. When pivot=link_id, returns dates as rows and links as columns. CSV/TSV includes header rows for name, full_url, and id.

timezonestring

The timezone to use for date/time calculations

frequency'day' | 'hour'

The frequency of data points in the response. Available options are 'day' (default) or 'hour'.

Response

Click

Example response

{
  "traffic": [
    {
      "t": "2026-06-01",
      "y": 12
    },
    {
      "t": "2026-06-02",
      "y": 8
    },
    {
      "t": "2026-06-03",
      "y": 21
    }
  ]
}