Skip to navigation
EcommerceRevenue Attribution

Get attribution metrics for one or more Brevo campaigns or workflows

View as Markdown

Retrieve aggregated ecommerce attribution metrics for one or more Brevo email campaigns, SMS campaigns, or automation workflows. You can optionally filter by a date range using periodFrom and periodTo in RFC3339 format. The response includes per-source metrics (orders count, revenue, and average basket) as well as aggregated totals across all requested sources.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

OR
AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Query parameters

periodFromdatetimeOptional
When getting metrics for a specific period, define the starting datetime in RFC3339 format
periodTodatetimeOptional
When getting metrics for a specific period, define the end datetime in RFC3339 format
emailCampaignId[]list of stringsOptional

The email campaign ID(s) to get metrics for

smsCampaignId[]list of stringsOptional

The SMS campaign ID(s) to get metrics for

automationWorkflowEmailId[]list of stringsOptional

The automation workflow ID(s) to get email attribution metrics for

automationWorkflowSmsId[]list of stringsOptional

The automation workflow ID(s) to get SMS attribution metrics for

Response

OK
resultslist of objects
List of conversion attribution metrics
totalsobject
Attribution list aggregated totals

Errors

400
Bad Request Error