Skip to main content
GET
V3 session and visitor facts

Authorizations

Authorization
string
header
required

API key created in the ZeroClick dashboard under Settings → API keys. Keys start with zc_. Send them as Authorization: Bearer zc_....

Path Parameters

sellerId
string
required
Minimum string length: 1

Query Parameters

startDate
string<date>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
endDate
string<date>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
asOf
string
Required string length: 1 - 80
limit
integer
default:50
Required range: 1 <= x <= 1000
offset
integer
default:0
Required range: 0 <= x <= 9007199254740991
scope
enum<string>
default:storefront
Available options:
storefront,
website
counting
enum<string>
default:visitors
Available options:
sessions,
visitors
hideBots
enum<string>
Available options:
true,
false
hideInternal
enum<string>
Available options:
true,
false
agentTypes
string
country
Available options:
unknown
identity
string
Required string length: 1 - 256
identityMatch
enum<string>
default:exact
Available options:
exact,
prefix
unmatchedOnly
enum<string>
Available options:
true,
false
outcome
enum<string>
Available options:
converted_paid,
converted_trial,
bought_unused,
handed_off,
quoted,
browsed,
left,
reached,
shown_link

Response

200 - application/json

Default Response

sessions
object
required