v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB

Email Campaigns

Get an email campaign report

get/emailCampaigns/{campaignId}

Path parameters

campaignIdinteger required

Id of the campaign

Query parameters

statistics'globalStats' | 'linksStats' | 'statsByDomain' | 'statsByDevice' | 'statsByBrowser'

Filter on the type of statistics required. Example globalStats value will only fetch globalStats info of the campaign in returned response.

Response

Email campaign informations

idinteger required

ID of the campaign

namestring required

Name of the campaign

subjectstring

Subject of the campaign. Only available if abTesting flag of the campaign is false

previewTextstring

Preview text or preheader of the email campaign

type'classic' | 'trigger' required

Type of campaign

Status of the campaign

scheduledAtstring

UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)

abTestingboolean

Status of A/B Test for the campaign. abTesting = false means it is disabled, & abTesting = true means it is enabled.

subjectAstring

Subject A of the ab-test campaign. Only available if abTesting flag of the campaign is true

subjectBstring

Subject B of the ab-test campaign. Only available if abTesting flag of the campaign is true

splitRuleinteger

The size of your ab-test groups. Only available if abTesting flag of the campaign is true

winnerCriteriastring

Criteria for the winning version. Only available if abTesting flag of the campaign is true

winnerDelayinteger

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

sendAtBestTimeboolean

It is true if you have chosen to send your campaign at best time, otherwise it is false

utmCampaignValuestring

utm parameter associated with campaign

utmSourcestring

source of utm parameter

utmMediumstring

medium parameter

utmIDinteger

utm id

testSentboolean required

Retrieved the status of test email sending. (true=Test email has been sent false=Test email has not been sent)

headerstring required

Header of the campaign

footerstring required

Footer of the campaign

replyTostring email required

Email defined as the "Reply to" of the campaign

toFieldstring

Customisation of the "to" field of the campaign

htmlContentstring required

HTML content of the campaign

shareLinkstring url

Link to share the campaign on social medias

tagstring

Tag of the campaign

createdAtstring required

Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

modifiedAtstring required

UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

inlineImageActivationboolean

Status of inline image. inlineImageActivation = false means image can’t be embedded, & inlineImageActivation = true means image can be embedded, in the email.

mirrorActiveboolean

Status of mirror links in campaign. mirrorActive = false means mirror links are deactivated, & mirrorActive = true means mirror links are activated, in the campaign

recurringboolean

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

sentDatestring

Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'

returnBounceinteger

Total number of non-delivered campaigns for a particular campaign id.

Example response

{
  "id": 12,
  "name": "EN - Sales Summer 2017",
  "subject": "20% OFF for 2017 Summer Sales",
  "previewText": "Thanks for your order!",
  "type": "classic",
  "status": "sent",
  "scheduledAt": "2017-06-01T12:30:00Z",
  "abTesting": true,
  "subjectA": "Discover the New Collection!",
  "subjectB": "Want to discover the New Collection?",
  "splitRule": 25,
  "winnerCriteria": "open",
  "winnerDelay": 50,
  "sendAtBestTime": true,
  "utmCampaignValue": "myutm",
  "utmSource": "Brevo",
  "utmMedium": "EMAIL",
  "utmID": 10,
  "testSent": true,
  "header": "[DEFAULT_HEADER]",
  "footer": "[DEFAULT_FOOTER]",
  "sender": {
    "name": "Marketing",
    "email": "marketing@mycompany.com",
    "id": 43
  },
  "replyTo": "replyto@domain.com",
  "toField": "{FNAME} {LNAME}",
  "htmlContent": "This is my HTML Content",
  "shareLink": "http://dhh.brevo.com/fhsgccc.html?t=9865448900",
  "tag": "Newsletter",
  "createdAt": "2017-05-01T12:30:00Z",
  "modifiedAt": "2017-05-01T12:30:00Z",
  "inlineImageActivation": true,
  "mirrorActive": true,
  "recurring": true,
  "sentDate": "2018-12-01T16:30:00Z",
  "returnBounce": 5,
  "recipients": {
    "lists": [
      21
    ],
    "exclusionLists": [
      13
    ]
  },
  "statistics": {
    "globalStats": {
      "listId": 2,
      "uniqueClicks": 2300,
      "clickers": 2665,
      "complaints": 1,
      "delivered": 19765,
      "sent": 19887,
      "softBounces": 100,
      "hardBounces": 87,
      "uniqueViews": 7779,
      "trackableViews": 5661,
      "trackableViewsRate": 23.45,
      "estimatedViews": 560,
      "unsubscriptions": 2,
      "viewed": 8999,
      "deferred": 30,
      "returnBounce": 5
    },
    "campaignStats": [
      {
        "listId": 2,
        "uniqueClicks": 2300,
        "clickers": 2665,
        "complaints": 1,
        "delivered": 19765,
        "sent": 19887,
        "softBounces": 100,
        "hardBounces": 87,
        "uniqueViews": 7779,
        "trackableViews": 5661,
        "trackableViewsRate": 23.45,
        "estimatedViews": 560,
        "unsubscriptions": 2,
        "viewed": 8999,
        "deferred": 30,
        "returnBounce": 5
      }
    ],
    "mirrorClick": 120,
    "remaining": 1000,
    "linksStats": {
      "example.abc.com": 7,
      "example.domain.com": 10
    }
  }
}