Skip to main content
POST
Create a report export

Authorizations

X-API-Key
string
header
required

An organization API key, prefixed bk_live_. Takes precedence over Authorization when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint.

Headers

X-Organization-Id
string<uuid>

Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403.

Body

application/json
reportType
enum<string>
required
Available options:
campaigns,
channel_performance,
engagement,
deliverability,
revenue_attribution
format
enum<string>
required
Available options:
csv,
pdf
fromDate
string
required
toDate
string
required

Response

success
boolean
required
Example:

true

message
string
required
data
object
required