Skip to content

Get Visitor Statistics

POST
/visitors/{resource}/statistics

Counts over the visitor stream, filtered.

companies counts UNIQUE BY IP, contacts does not - the two series are not comparable row for row and should not be charted as if they were.

Authorizations

Parameters

Path Parameters

resource
required

What to count.

string
Allowed values: contacts companies

What to count.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body

Filter conditions, each {field, operator, value} - e.g. {"field": "received_at", "operator": "greaterThanOrEqual", "value": "2025-01-01"}. An empty list means no filtering. Left as an open shape because the operator vocabulary is the app’s and still moves; an enum here would reject a filter the app accepts.

Array<object>
object
key
additional properties
any

Responses

200

Successful Response

object
data
required

Counts over the visitor stream.

companies counts UNIQUE BY IP and contacts does not, so the two series are not comparable row for row - charting them on one axis as if they were overstates or understates one of them depending on traffic shape.

object
series
Array<object>
object
key
additional properties
any
total
Any of:
integer
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string