API REFERENCE

Statistics API

41 REST endpoints for statistics, each with its parameters, the response it returns and a runnable curl example. Starts with GET /api/statistics/clickstream.

⌕All resources

GET/api/statistics/clickstream

Get statistics clickstream

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 5

Name	In	Description
`domainId`	query	Optional query parameter
`linkId`	query	Optional query parameter
`limit`	query	Optional query parameter
`offset`	query	Optional query parameter
`format`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/api/statistics/domain/{id}

Domain statistics

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 9

Name	In	Description
`id`	path	Required path parameter
`period`	query	Optional query parameter
`startDate`	query	Optional query parameter
`endDate`	query	Optional query parameter
`interval`	query	Optional query parameter
`column`	query	Optional query parameter
`limit`	query	Optional query parameter
`offset`	query	Optional query parameter
`tz`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/api/statistics/domain/{id}

Domain statistics

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/api/statistics/domain/{id}/by_interval

Statistics data by interval

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/api/statistics/domain/{id}/last_clicks

List of raw clicks

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/api/statistics/domain/{id}/link_clicks

Link clicks

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 9

Name	In	Description
`id`	path	Required path parameter
`period`	query	Optional query parameter
`startDate`	query	Optional query parameter
`endDate`	query	Optional query parameter
`interval`	query	Optional query parameter
`column`	query	Optional query parameter
`limit`	query	Optional query parameter
`offset`	query	Optional query parameter
`tz`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/api/statistics/domain/{id}/link_clicks

Link clicks

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/api/statistics/domain/{id}/paths

Most popular links in a time interval

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

DELETE/api/statistics/domain/{id}/statistics

Clear domain statistics

Open interactive reference →

Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.

Parameters 2

Name	In	Description
`id`	path	Required path parameter
`confirm`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/api/statistics/domain/{id}/top

Top values ordered by clicks

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/api/statistics/domain/{id}/top_by_interval

Top values by column and interval

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/api/statistics/link/{id}

Link statistics

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 9

Name	In	Description
`id`	path	Required path parameter
`period`	query	Optional query parameter
`startDate`	query	Optional query parameter
`endDate`	query	Optional query parameter
`interval`	query	Optional query parameter
`column`	query	Optional query parameter
`limit`	query	Optional query parameter
`offset`	query	Optional query parameter
`tz`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/api/statistics/link/{id}

Link statistics

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/api/statistics/link/{id}/by_interval

Statistics data by interval

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/api/statistics/link/{id}/top

Top values ordered by clicks

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/api/statistics/overview

Organisation-wide overview (dashboard home cards)

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 1

Name	In	Description
`interval`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/api/statistics/share

Get statistics share

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/api/statistics/share

Shareable public statistics links

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 4

Name	In	Description
`domainId`	body	JSON request field
`linkId`	body	JSON request field
`expiresAt`	body	JSON request field
`windowDays`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

DELETE/api/statistics/share/{id}

Delete statistics share by ID

Open interactive reference →

Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.

Parameters 1

Name	In	Description
`id`	path	Required path parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/statistics/click/{clid}

One click, in full

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 1

Name	In	Description
`clid`	path	Required path parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/statistics/clickstream

Get statistics clickstream

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 5

Name	In	Description
`domainId`	query	Optional query parameter
`linkId`	query	Optional query parameter
`limit`	query	Optional query parameter
`offset`	query	Optional query parameter
`format`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/statistics/domain/{id}

Domain statistics

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 9

Name	In	Description
`id`	path	Required path parameter
`period`	query	Optional query parameter
`startDate`	query	Optional query parameter
`endDate`	query	Optional query parameter
`interval`	query	Optional query parameter
`column`	query	Optional query parameter
`limit`	query	Optional query parameter
`offset`	query	Optional query parameter
`tz`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/statistics/domain/{id}

Domain statistics

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/statistics/domain/{id}/by_interval

Statistics data by interval

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/statistics/domain/{id}/clickstream

Get statistics domain by ID clickstream

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 6

Name	In	Description
`id`	path	Required path parameter
`domainId`	query	Optional query parameter
`linkId`	query	Optional query parameter
`limit`	query	Optional query parameter
`offset`	query	Optional query parameter
`format`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/statistics/domain/{id}/details/{dimension}

Get statistics domain by ID details :dimension

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 4

Name	In	Description
`id`	path	Required path parameter
`dimension`	path	Required path parameter
`interval`	query	Optional query parameter
`series`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/statistics/domain/{id}/export

XLS export of the statistics view

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 2

Name	In	Description
`id`	path	Required path parameter
`interval`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/statistics/domain/{id}/filter-values

Filter option values (for the filters modal)

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 1

Name	In	Description
`id`	path	Required path parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/statistics/domain/{id}/last_clicks

List of raw clicks

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/statistics/domain/{id}/link_clicks

Link clicks

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 9

Name	In	Description
`id`	path	Required path parameter
`period`	query	Optional query parameter
`startDate`	query	Optional query parameter
`endDate`	query	Optional query parameter
`interval`	query	Optional query parameter
`column`	query	Optional query parameter
`limit`	query	Optional query parameter
`offset`	query	Optional query parameter
`tz`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/statistics/domain/{id}/link_clicks

Link clicks

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/statistics/domain/{id}/paths

Most popular links in a time interval

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 9

Name	In	Description
`id`	path	Required path parameter
`period`	query	Optional query parameter
`startDate`	query	Optional query parameter
`endDate`	query	Optional query parameter
`interval`	query	Optional query parameter
`column`	query	Optional query parameter
`limit`	query	Optional query parameter
`offset`	query	Optional query parameter
`tz`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/statistics/domain/{id}/paths

Most popular links in a time interval

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

DELETE/statistics/domain/{id}/statistics

Clear domain statistics

Open interactive reference →

Removes the selected resource after authorization. Access is limited by the API key scope and the workspace plan.

Parameters 2

Name	In	Description
`id`	path	Required path parameter
`confirm`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/statistics/domain/{id}/top

Top values ordered by clicks

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 9

Name	In	Description
`id`	path	Required path parameter
`period`	query	Optional query parameter
`startDate`	query	Optional query parameter
`endDate`	query	Optional query parameter
`interval`	query	Optional query parameter
`column`	query	Optional query parameter
`limit`	query	Optional query parameter
`offset`	query	Optional query parameter
`tz`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/statistics/domain/{id}/top

Top values ordered by clicks

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/statistics/domain/{id}/top_by_interval

Top values by column and interval

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

GET/statistics/link/{id}

Link statistics

Open interactive reference →

Returns data without changing the resource. Access is limited by the API key scope and the workspace plan.

Parameters 9

Name	In	Description
`id`	path	Required path parameter
`period`	query	Optional query parameter
`startDate`	query	Optional query parameter
`endDate`	query	Optional query parameter
`interval`	query	Optional query parameter
`column`	query	Optional query parameter
`limit`	query	Optional query parameter
`offset`	query	Optional query parameter
`tz`	query	Optional query parameter

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/statistics/link/{id}

Link statistics

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/statistics/link/{id}/by_interval

Statistics data by interval

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited

POST/statistics/link/{id}/top

Top values ordered by clicks

Open interactive reference →

Validates the payload and returns the resulting resource. Access is limited by the API key scope and the workspace plan.

Parameters 11

Name	In	Description
`id`	path	Required path parameter
`period`	body	JSON request field
`startDate`	body	JSON request field
`endDate`	body	JSON request field
`interval`	body	JSON request field
`column`	body	JSON request field
`limit`	body	JSON request field
`offset`	body	JSON request field
`include`	body	JSON request field
`exclude`	body	JSON request field
`tz`	body	JSON request field

Examples in 22 languages and Try it →

Responses

200 Success400 Invalid request401 Invalid key429 Rate limited