Skip to main content

Call

A tracking call in the Segment format. Fields not listed are kept as sent.

typestringrequired

Possible values: [page, track, identify, alias, group, screen]

messageIdstring

Idempotency key of the activities the call becomes; assigned when missing.

eventstring

The name of a track call.

namestring

The name of a page or screen.

anonymousIdstring
userIdstring
timestampstring<date-time>
originalTimestampstring<date-time>

Preferred over timestamp when present, as RudderStack sends it.

properties object
property name*any
traits object
property name*any
context object
page object

url, path, title, referrer

property name*any

url, path, title, referrer

campaign object

UTMs as typed: source, medium, name, term, content.

property name*any

UTMs as typed: source, medium, name, term, content.

userAgentstring
sessionId

A string or a number.

sessionStartboolean

First call of a session; also yields started_session.

evx object

What the Segment format has no field for.

owner_refstring

The owner of the page, with a group key.

click_ids object
property name*string
consent object
analyticsboolean
adsboolean
personalisationboolean
property name*any
Call
{
"type": "page",
"messageId": "string",
"event": "string",
"name": "string",
"anonymousId": "string",
"userId": "string",
"timestamp": "2024-07-29T15:51:28.071Z",
"originalTimestamp": "2024-07-29T15:51:28.071Z",
"properties": {},
"traits": {},
"context": {
"page": {},
"campaign": {},
"userAgent": "string",
"sessionStart": true,
"evx": {
"owner_ref": "string",
"click_ids": {},
"consent": {
"analytics": true,
"ads": true,
"personalisation": true
}
}
}
}