Export events


Export events for a selected single customer.



In this API call you must use the following authorization access and permissions:

Available access typePermissions needed
Private accessEvents > Get

Read more about:

Path parameters

projectTokenstringThe ID of your project.Required

Body parameters

customer_idsObject of stringsOne or more hard and/or soft customer IDs are required. The most common ones include: registered.At least 1 required.
event_typesArray of stringsThe names of the events that you want to export. Remember to grant Get permission for all listed events.Required
orderStringOrder by timestamp. asc for ascending (oldest to newest), desc for descending (newest to oldest). Default: asc.No
limitInt32The number of items to return. If not specified in the request, all events are returned.No
skipInt32The number of items to skip over. Default: 0No


authorizationstringUsed for authentication. Read more in the Authentication section.Required

Additional payload example

 "customer_ids": {
  "cookie": "382d4221-3441-44b7-a676-3eb5f515157f"
 "event_types": [
 "order": "asc",
 "limit": 3,
 "skip": 100


For some use cases, it might be better to use the Data Exports Bloomreach Engagement feature, since the API does not support date filtering (note that Exports are a paid feature).

Click Try It! to start a request and see the response here!