Skip to main content
POST
Record a visit

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your API token.

Body

application/json
utmSource
string | null
Maximum string length: 255
utmMedium
string | null
Maximum string length: 255
utmCampaign
string | null
Maximum string length: 255
utmTerm
string | null
Maximum string length: 255
utmContent
string | null
Maximum string length: 255
landingPage
string | null
Maximum string length: 2048
referrer
string | null
Maximum string length: 2048
sessionId
string | null

Existing session id to continue touchpoint tracking; a new one is generated when omitted.

Maximum string length: 64

Response

Created

id
string<uuid>

The stored visit id.

sessionId
string

Session id used for touchpoint tracking; echoes the supplied value or a newly generated one.