Sign in
latestSwagger 2.02026-08-10148196271.0 KB

afaab604b58c

events

Track an event

Events are created asynchronously and <b>processed separately from single event (non-bulk) endpoint</b>. To make sure events are tracked in order, send them all to the same endpoint (either bulk or non-bulk). <br/><br/>There is a soft limit (default is 8,000) on the number of unique fields a custom event can have. For events of the same name, identically named data fields must be of the same type.<br/><br/>Learn about <a href="https://support.iterable.com/hc/articles/29156459027348">identifying users by <code>userId</code> and <code>email</code></a>.<br/><br/><b>Rate limit</b>: 2000 requests/second, per project.<br/><br/>

post/api/events/track

Request body

campaignIdinteger

Campaign tied to conversion

createNewFieldsboolean

Whether new fields should be ingested and added to the schema. Defaults to project's setting to allow or drop unrecognized fields.

createdAtinteger

Time event happened. Set to the time event was received if unspecified. Expects a unix timestamp.

dataFieldsobject

Additional data associated with event (i.e. item amount, item quantity). For events of the same name, identically named data fields must be of the same type.

emailstring

An email address that identifies a user profile in Iterable. Provide an <code>email</code> or a <code>userId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.

eventNamestring required

Name of event

idstring

Optional event id. If an event exists with that id, the event will be updated. If none is specified, a new id will automatically be generated and returned. Note that this ID cannot be longer than 512 bytes.

templateIdinteger

Template id

userIdstring

A user ID that identifies a user profile in Iterable. Provide an <code>email</code> or a <code>userId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.

Response

successful operation