Skip to main content
GET
Account analytics summary

Authorizations

Authorization
string
header
required

API key issued in the dashboard. Server-side only: never ship it to a browser, and never pass it as a query parameter.

Query Parameters

start_date
integer
required

Start of the period, UTC milliseconds. Inclusive.

Example:

1755734400000

end_date
integer
required

End of the period, UTC milliseconds. Inclusive, and silently clamped to the current server time if it lies in the future.

Example:

1756339200000

timezone
string
required

IANA timezone. Buckets and the activity grid are cut in it; totals do not depend on it.

Maximum string length: 64
Example:

"Europe/Belgrade"

Response

object
enum<string>
required
Available options:
analytics
visitors
integer
required

Unique visitors, summed across the links of the scope. A person who visited two links counts twice.

Example:

1240

visits
integer
required
Example:

1580

countries
object[] | null
required

Top countries as ISO 3166-1 alpha-2 codes. Null when your plan does not include breakdowns.

referrers
object[] | null
required

Top referring domains. Null when your plan does not include breakdowns.

channels
object[] | null
required

Traffic channels, e.g. direct, organicSearch, paidAds. Null when your plan does not include breakdowns.

browsers
object[] | null
required

Top browsers. Null when your plan does not include breakdowns.

operating_systems
object[] | null
required

Top operating systems. Null when your plan does not include breakdowns.

devices
object[] | null
required

Top device classes: desktop, mobile, tablet. Null when your plan does not include breakdowns.

activity
object | null
required

When the traffic arrives. Null when your plan does not include breakdowns.

clicks
integer
required

Clicks on widgets of the landing pages in this scope.

Example:

310

direct_button_clicks
integer
required
Example:

64

tease_chat
object
required

Busiest links of the scope, at most five. Links without visitors are omitted, so the array is empty when there was no traffic.