INinfobip
customer-engagement
people
events

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.

post/peopleevents/1/export

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Request body

roleArnstring required

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.

bucketstring required

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

regionstring required

AWS S3 client region.

directoryPathstring

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.

startTimestring required

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.

endTimestring required

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.

definitionIdListstring[]

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.

enrichWithMomentsInfoboolean

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.

Response

Accepted

requestIdstring required

Event export request ID.

Changes

No recorded changes to this operation across all 1 revision of this API.