Skip to main content
POST
Get Batch Campaign Stats
Careful, the route starts with /v2/. Make sure to include the version in the path.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
campaignIds
string[]
required

Array of campaign IDs to retrieve stats for

Required array length: 1 - 100 elements
Example:
startDate
string
required

Start date in ISO 8601 format

Example:

"2024-01-07T22:00:00.000Z"

endDate
string
required

End date in ISO 8601 format

Example:

"2025-07-10T21:59:59.999Z"

sendUser
string

Filter stats by send user. Format: sendUserId|sendUserEmail. The sendUserId should begin with 'usr_' and the sendUserEmail should be a valid sender email. If the param is specified, both sendUserId and sendUserEmail are mandatory.

Example:

"usr_OcIHizJyIeaDxicQP|email@example.com"

ABSelected
enum<string>

A/B version filter

Available options:
A,
B
channels
enum<string>[]

Filter by communication channels

Available options:
email,
linkedin,
others

Response

Success

results
object[]

Array of campaign stats results

errors
object[]

Array of errors for campaigns that failed to retrieve stats