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.
Authorizations:
Scopes:
Request Body schema:
application/jsonroleArn required | string AWS role ARN for accessing S3 bucket. Accepted format: |
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 |
startTime required | string Start time of the export query. Accepted format: |
endTime required | string End time of the export query. Accepted format: |
definitionIdList | Array of strings <= 200 items An optional list of |
enrichWithMomentsInfo | boolean If set to |
Responses
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
Too Many Requests
Internal Server Error
Request samples
- Payload
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
{- "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
- 202
- 400
- 401
- 403
- 404
- 429
- 500
{- "requestId": "4c959f87-9a45-4e16-bcd2-7f2a79e95067"
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See