Import a collection of events

Imports a batch of events associated to contacts.

🚫

You must be on our CXDP account package to access this feature.

Collate and upload events to Dotdigital Marketing from your platforms which can be shown on a contact's Single customer view. The data is also available as an Insight data collection for use in segmentation and personalization.


Events

Each event must be associated with an existing contact within Dotdigital Marketing using any contact identifier type you want, including Custom identifiers.

Each event has:

FieldDescription
typeThe notional type of the event which is displayed on the contact's timeline on the Single customer view.
idA unique ID for the event, for example, a GUID.
eventTimestampThe UTC date and time the event occurred in ISO 8601 format.
timelineDetails.summaryIf specified, this is the description of the event to be shown in the contact's timeline on the Single customer view.
eventDataThe actual data for the event as a JSON object.
❗️

The type of an event must not conflict with the existing standard types of:

  • cartInsight
  • catalog
  • consentInsight
  • easyEditorExtensions
  • nostoEmailCampaigns
  • orders
  • productCategories
  • webInsight
  • wishList
🚧

Batching

For efficiency, we strongly recommend batching and importing your events in bulk. You can import up to 50MB of data per request. These events are then asynchronously imported in the background.


Body Params

Events to be imported

The events to import.

An event

contactIdentity
object
required

The way to identify the contact the event is associated to.

string
required
length between 1 and 80

The event type

string

The unique id for the event.

string
Defaults to <Current date and time>

The UTC date and time the event occurred in ISO 8601 format.

Note: Optional and will default to when we process the event if not specified.

timelineDetails
object

The details to display in the contacts timeline; if omitted nothing will be shown.

eventData
object

Any addtional data attributes for the event.

Headers
string
/^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$/

If you are a partner of Dotdigital and have a verified integration then include your integration tracking token here.

Responses
202

Import processing

401

Unauthorized

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json