Definition

Authorization

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

Available access type	Permissions needed
Private access	Events > Get

Path parameters

Parameter	Type	Description	Required
projectToken	string	The ID of your project.	Required

Body parameters

Parameter	Type	Description	Required
customer_ids	Object of strings	One or more hard and/or soft customer IDs are required. The most common ones include: `registered`.	At least 1 required.
event_types	Array of strings	The names of the events that you want to export. Remember to grant Get permission for all listed events.	Required
order	String	Order by timestamp. `asc` for ascending (oldest to newest), `desc` for descending (newest to oldest). Default: `asc`.	No
limit	Int32	The number of items to return. If not specified in the request, all events are returned.	No
skip	Int32	The number of items to skip over. Default: 0	No

Headers

Parameter	Type	Description	Required
authorization	string	Used for authentication. Read more in the Authentication section.	Required
content-type	string	application/json	Required

Additional payload example

{
 "customer_ids": {
  "cookie": "382d4221-3441-44b7-a676-3eb5f515157f"
 },
 "event_types": [
  "session_start",
  "payment"
 ],
 "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).