FIELD

REQUIRED?

TYPE

DESCRIPTION

anonymousId

required; optional if userID is set instead

String

A pseudo-unique substitute for a User ID, for cases when you don’t have an absolutely unique identifier. A userId or an anonymousId is required.

context

optional

Object

Dictionary of extra information that provides useful context about a message, but is not directly related to the API call like ip address or locale

integrations

optional

Object

Dictionary of destinations to either enable or disable.

messageId

implicit

String

Automatically collected by Segment, a unique identifier for each message that lets you find an individual message across the API.

receivedAt

implicit

Date

Automatically set by Segment, the timestamp of when a message is received by Segment It is an ISO-8601 date string.

sentAt

optional

Date

Timestamp of when a message is sent to Segment, used for clock skew correction It is set automatically by the Segment tracking libraries. It is an ISO-8601 date string.

timestamp

optional

Date

Timestamp when the message itself took place, defaulted to the current time by the Segment Tracking API, as a ISO-8601 format date string. If the event just happened, leave it out and we’ll use the server’s time. If you’re importing data from the past, make sure you to provide a timestamp.

type

implicit

String

Type of message, corresponding to the API method: 'identify', 'group', 'track', and 'page'.

userId

required; optional if anonymousID is set instead

String

Unique identifier for the user in your database. A userId or an anonymousId is required.

version

implicit

Number

Version of the Tracking API that received the message, automatically set by http://journy.io .

FIELD

TYPE

DESCRIPTION

active

Boolean

Whether a user is active.
​
This is usually used to flag an .identify() call to just update the traits but not “last seen.”

app

Object

dictionary of information about the current application, containing name, version, and build.
​
This is collected automatically from the mobile libraries when possible.

campaign

Object

Dictionary of information about the campaign that resulted in the API call, containing name, source, medium, term, content, and any other custom UTM parameter.
​
This maps directly to the common UTM campaign parameters.

device

Object

Dictionary of information about the device, containing id, advertisingId, manufacturer, model, name, type, and version.

ip

String

Current user’s IP address.

library

Object

Dictionary of information about the library making the requests to the API, containing name and version.

locale

String

Locale string for the current user, for example en-US.

network

Object

Dictionary of information about the current network connection, containing bluetooth, carrier, cellular, and wifi. If the context.network.cellular and context.network.wifi fields are empty, then the user is offline.

os

Object

Dictionary of information about the operating system, containing name and version.

page

Object

Dictionary of information about the current page in the browser, containing path, referrer, search, title and url. This is automatically collected by Analytics.js.

referrer

Object

Dictionary of information about the way the user was referred to the website or app, containing type, name, url, and link.

screen

Object

Dictionary of information about the device’s screen, containing density, height, and width.

timezone

String

Timezones are sent as tzdata strings to add user timezone information which might be stripped from the timestamp, for example America/New_York.

groupId

String

Group / Account ID.
​
This is useful in B2B use cases where you need to attribute your non-group calls to a company or account. It is relied on by several Customer Success and CRM tools.

traits

Object

Dictionary of traits of the current user.
​
This is useful in cases where you need to track an event, but also associate information from a previous identify call. You should fill this object the same way you would fill traits in an identify call.

userAgent

String

User agent of the device making the request.

userAgentData

Object

The user agent data of the device making the request. This always contains brands, mobile, platform, and may contain bitness, model, platformVersion,uaFullVersion, fullVersionList, wow64, if requested and available.
​
This populates if the Client Hints API is available on the browser.
​
This may contain more information than is available in the userAgent in some cases.

channel

String

where the request originated from: server, browser or mobile