Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Beyond this common structure, each API call adds a few specialized top-level fields.

...