Submit event export request

Events export allows you to asynchronously export People Events data to a compressed file or multiple files in your AWS S3 bucket.

Refer to product documentation for detailed information on configuring AWS S3 for export, export file format and event data schema.

Throttling

You can have maximum of 72 hours worth of export requests in progress at one time.

Please log in to see full path URL. Learn why.
post
/peopleevents/1/export
Request Body schema:
application/json
collapse all -
roleArn
required
string

AWS role ARN for accessing S3 bucket. Accepted format: arn:aws:iam::account:role/role-name-with-path. Must apply character rules as referenced in AWS documentation.

bucket
required
string

AWS S3 bucket name. Must only contain safe characters, as defined in AWS documentation.

region
required
string

AWS S3 client region.

directoryPath
string

AWS S3 directory path. Use directory/ or a nested directory path dir1/dir2/directory/. Must only contain safe characters or an equal sign, as defined in AWS documentation.

startTime
required
string

Start time of the export query. Accepted format: yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g. 2022-03-01T01:00:00.000+0000. Must be earlier than the current time and endTime, but no more than 1 year ago. startTime and endTime must be at most 24 hours apart.

endTime
required
string

End time of the export query. Accepted format: yyyy-MM-dd'T'HH:mm:ss.SSSZ, e.g. 2022-03-01T01:00:00.000+0000. Must be earlier than the current time, and later than startTime. startTime and endTime must be at most 24 hours apart.

definitionIdList
Array of strings <= 200 items

An optional list of definitionIds to use as a whitelist filter for exported events. Accepted format: ["definitionId", "definitionId"], e.g. ["formSubmitted", "sms*"]. A wildcard character '*' may be used to match any number of characters in the definitionId. A list of all valid definitionIds can be obtained from the Get list of event definitions endpoint. The total number of matched definitionIds, after wildcard expansion, may not exceed 200. To export all events without filtering, do not specify a definitionIdList.

enrichWithMomentsInfo
boolean

If set to true, additional information, namely the campaign name, Flow's element name (if applicable), and the campaign start date and time are added to all existing events related to Moments. Defaults to false.

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

500

Internal Server Error

Request samples

Content type
application/json
Example
Copy
Collapse all
{
  • "roleArn": "arn:aws:iam::account:role/role-name-with-path",
  • "bucket": "exported-events-bucket",
  • "region": "EU_CENTRAL_1",
  • "startTime": "2022-01-01T00:00:00.000+0000",
  • "endTime": "2022-01-01T01:00:00.000+0000"
}

Response samples

Content type
application/json
Copy
Collapse all
{
  • "requestId": "4c959f87-9a45-4e16-bcd2-7f2a79e95067"
}

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products
Learn more
Service status

Copyright @ 2006-2025 Infobip ltd.