Get an email campaign report
Retrieve detailed information about a specific email campaign by its ID, including recipients, statistics, and HTML content. Use the statistics query parameter to select which statistics to include (globalStats, linksStats, statsByDomain, statsByDevice, or statsByBrowser); statsByDevice and statsByBrowser are only available on this single-campaign endpoint. You can exclude HTML content from the response by setting excludeHtmlContent to true.
Authentication
The API key should be passed in the request headers as api-key for authentication.
OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.
Path parameters
Query parameters
Filter on the type of statistics required. Example: globalStats value will only fetch globalStats info of the campaign in the returned response. statsByDevice and statsByBrowser are only available when retrieving a single campaign (not in the list endpoint).
Use this flag to exclude htmlContent from the response body. If set to true, htmlContent field will be returned as empty string in the response body
Response
Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)
Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent)
Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.
UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)
The size of your ab-test groups. Only available if abTesting flag of the campaign is true
Subject of the campaign. Only available if abTesting flag of the campaign is false
Subject A of the ab-test campaign. Only available if abTesting flag of the campaign is true
Subject B of the ab-test campaign. Only available if abTesting flag of the campaign is true
Criteria for the winning version. Only available if abTesting flag of the campaign is true
The duration of the test in hours at the end of which the winning version will be sent. Only available if abTesting flag of the campaign is true
Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email.
Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign
FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false means contact can receive the same Trigger campaign only once, & recurring = true means contact can receive the same Trigger campaign several times
Total number of non-delivered campaigns for a particular campaign id.
Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if ‘status’ of the campaign is ‘sent’
The utm_campaign value applied to the campaign’s tracking links. Falls back to your account’s global UTM settings when no custom value was set on the campaign, or the campaign name if neither is configured. Only returned when UTM tracking is enabled on the campaign.
The utm_content value applied to the campaign’s tracking links. Falls back to your account’s global UTM settings when no custom value was set on the campaign. Only returned when UTM tracking is enabled on the campaign and a value is set at one of these levels.
Legacy numeric utm_id value applied to the campaign’s tracking links. Present only when UTM tracking is enabled on the campaign and the resolved utm_id is numeric (typically the campaign’s ID). For customer-supplied non-numeric values (for example promo_042), read utmId (string) instead. Kept for backward compatibility.
The utm_id value applied to the campaign’s tracking links, returned verbatim as a string. Falls back to your account’s global UTM settings when no custom value was set on the campaign. Only returned when UTM tracking is enabled on the campaign and a value is set at one of these levels. Preferred field for new consumers — covers both numeric IDs and customer-supplied non-numeric strings.
The utm_medium value applied to the campaign’s tracking links. Falls back to your account’s global UTM settings when no custom value was set on the campaign, or the default email if neither is configured. Case is preserved verbatim. Only returned when UTM tracking is enabled on the campaign.
The utm_source value applied to the campaign’s tracking links. Falls back to your account’s global UTM settings when no custom value was set on the campaign, or the account default (brevo or sendinblue) if neither is configured. Case is preserved verbatim. Only returned when UTM tracking is enabled on the campaign.
The utm_term value applied to the campaign’s tracking links. Falls back to your account’s global UTM settings when no custom value was set on the campaign. Only returned when UTM tracking is enabled on the campaign and a value is set at one of these levels.