Export events

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use this endpoint to export events for a single selected customer.

Authorization

This endpoint requires the following access type and permissions:

Available access typePermissions needed
Private accessEvents > Get

For more details, see:

Payload example

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

Note

For use cases that require date filtering, the Data Exports feature may be a better fit. Note that Data Exports is a paid feature.

Path Params
string
required
Defaults to 12345678-1234-1234-1234-123456789abc

The ID of your project.

Body Params
customer_ids
object
required

One or more hard and/or soft customer IDs are required. The most common ones include: registered.

event_types
array of strings
required

The names of the events you want to export. Remember to grant Get permission for all listed events.

event_types*
string
Defaults to asc

Order by timestamp. asc for ascending (oldest to newest), desc for descending (newest to oldest). Default: asc.

int32
Defaults to 3

The number of items to return. If not specified, all events are returned.

int32
Defaults to 10

The number of items to skip over. Default: 0.

Headers
string
required
Defaults to Basic <KeyID/Secret>

Used for authentication. See the Authentication section for details.

Responses

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

© Bloomreach, Inc. All rights reserved.