Get Visitor Contact Metrics

GET

/visitors/contacts-metrics

• Production
• QA

Identified-contact metrics over time.

The path is contacts-metrics, hyphenated, matching every other path on this surface - the app’s contacts_metrics is the odd one out.

Authorizations

• BearerAuth

Parameters

Query Parameters

timeframe

Preset period.

string

default: last_7_days

Preset period.

interval

Any of:

string

string

null

null

Day | week | month | quarter.

start_date

Any of:

string

string

null

null

Custom start, YYYY-MM-DD.

end_date

Any of:

string

string

null

null

Custom end, YYYY-MM-DD.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

object

key

additional properties

any

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string