Segment

Segment integration (Data, Marketing). Imported from open-connector.

API key7 toolshttps://api.segment.io/v1

POST

segment_identify

Send a Segment Identify call to record user traits.

/identify

8 parameters

Param	Type	Required	Description
userId	string	optional	Unique identifier for the user in your database.
anonymousId	string	optional	Pseudo-unique anonymous identifier for the user.
context	object	optional	Segment context object with extra information about the event.
integrations	object	optional	Segment destination flags keyed by destination name.
timestamp	string	optional	Timestamp when the message took place, in ISO 8601 format.
sentAt	string	optional	Timestamp when the message was sent to Segment, in ISO 8601 format.
messageId	string	optional	Unique message identifier used by Segment for deduplication.
traits	object	optional	Free-form traits associated with the user.

POST

segment_track

Send a Segment Track call to record one user event.

/track

9 parameters

Param	Type	Required	Description
userId	string	optional	Unique identifier for the user in your database.
anonymousId	string	optional	Pseudo-unique anonymous identifier for the user.
context	object	optional	Segment context object with extra information about the event.
integrations	object	optional	Segment destination flags keyed by destination name.
timestamp	string	optional	Timestamp when the message took place, in ISO 8601 format.
sentAt	string	optional	Timestamp when the message was sent to Segment, in ISO 8601 format.
messageId	string	optional	Unique message identifier used by Segment for deduplication.
event	string	required	Name of the action the user performed.
properties	object	optional	Free-form properties associated with the event.

POST

segment_page

Send a Segment Page call to record a website page view.

/page

9 parameters

Param	Type	Required	Description
userId	string	optional	Unique identifier for the user in your database.
anonymousId	string	optional	Pseudo-unique anonymous identifier for the user.
context	object	optional	Segment context object with extra information about the event.
integrations	object	optional	Segment destination flags keyed by destination name.
timestamp	string	optional	Timestamp when the message took place, in ISO 8601 format.
sentAt	string	optional	Timestamp when the message was sent to Segment, in ISO 8601 format.
messageId	string	optional	Unique message identifier used by Segment for deduplication.
name	string	optional	Optional page name.
properties	object	optional	Free-form properties associated with the page.

POST

segment_screen

Send a Segment Screen call to record a mobile app screen view.

/screen

9 parameters

Param	Type	Required	Description
userId	string	optional	Unique identifier for the user in your database.
anonymousId	string	optional	Pseudo-unique anonymous identifier for the user.
context	object	optional	Segment context object with extra information about the event.
integrations	object	optional	Segment destination flags keyed by destination name.
timestamp	string	optional	Timestamp when the message took place, in ISO 8601 format.
sentAt	string	optional	Timestamp when the message was sent to Segment, in ISO 8601 format.
messageId	string	optional	Unique message identifier used by Segment for deduplication.
name	string	optional	Optional screen name.
properties	object	optional	Free-form properties associated with the screen.

POST

segment_group

Send a Segment Group call to associate a user with a group.

/group

9 parameters

Param	Type	Required	Description
userId	string	optional	Unique identifier for the user in your database.
anonymousId	string	optional	Pseudo-unique anonymous identifier for the user.
context	object	optional	Segment context object with extra information about the event.
integrations	object	optional	Segment destination flags keyed by destination name.
timestamp	string	optional	Timestamp when the message took place, in ISO 8601 format.
sentAt	string	optional	Timestamp when the message was sent to Segment, in ISO 8601 format.
messageId	string	optional	Unique message identifier used by Segment for deduplication.
groupId	string	required	Unique identifier for the group in your database.
traits	object	optional	Free-form traits associated with the group.

POST

segment_alias

Send a Segment Alias call to associate one user identity with another.

/alias

7 parameters

Param	Type	Required	Description
userId	string	required	Unique identifier for the user in your database.
previousId	string	required	Previous unique identifier for the user.
context	object	optional	Segment context object with extra information about the event.
integrations	object	optional	Segment destination flags keyed by destination name.
timestamp	string	optional	Timestamp when the message took place, in ISO 8601 format.
sentAt	string	optional	Timestamp when the message was sent to Segment, in ISO 8601 format.
messageId	string	optional	Unique message identifier used by Segment for deduplication.

POST

segment_batch

Send a Segment Batch call containing Identify, Group, Track, Page, or Screen items.

/batch

3 parameters

Param	Type	Required	Description
batch	array	required	Segment event items to send in this batch.
context	object	optional	Segment context object with extra information about the event.
integrations	object	optional	Segment destination flags keyed by destination name.