Skip to main content
GET
Query analytics totals and breakdowns

Authorizations

Authorization
string
header
required

Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.

Path Parameters

websiteId
string
required
Minimum string length: 1

Query Parameters

startAt
integer
required
Required range: 0 <= x <= 9007199254740991
endAt
integer
required
Required range: 0 <= x <= 9007199254740991
path
string
referrer
string
title
string
query
string
browser
string
os
string
device
string
country
string
region
string
city
string
language
string
hostname
string
tag
string
event
string
distinctId
string
utmSource
string
utmMedium
string
utmCampaign
string
utmContent
string
utmTerm
string
segment
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
cohort
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
dimension
enum<string>

Break the range down by this dimension, e.g. path for top pages, referrer for top referrers, country for top countries. Omit for totals only.

Available options:
path,
entry,
exit,
title,
query,
referrer,
channel,
domain,
country,
region,
city,
browser,
os,
device,
language,
screen,
event,
hostname,
tag,
distinctId
limit
integer
default:25

Maximum number of dimension rows to return (default 25, max 1000). Only used when dimension is set.

Required range: 1 <= x <= 1000

Response

Engagement totals for the range, plus ranked rows when a dimension was requested.

pageviews
number
required

Total page views.

visitors
number
required

Distinct visitors.

visits
number
required

Visits (sessions).

bounces
number
required

Single-page visits.

totaltime
number
required

Total time spent in seconds, summed across visits.

comparison
object

Totals for the comparison period, present when the provider computes one.

rows
object[]

Values of the requested dimension ranked by page views, each with its own engagement totals. Present only when dimension is set.