Sign in

v1

latestSwagger 2.0MIT2026-07-17233380637.0 KB
Email Campaigns

Return all your created email campaigns

get/emailCampaigns

Query parameters

type'classic' | 'trigger'

Filter on the type of the campaigns

status'suspended' | 'archive' | 'sent' | 'queued' | 'draft' | 'inProcess'

Filter on the status of the campaign

statistics'globalStats' | 'linksStats' | 'statsByDomain'

Filter on the type of statistics required. Example globalStats value will only fetch globalStats info of the campaign in returned response.This option only returns data for events occurred in the last 6 months.For older campaigns, it’s advisable to use the Get Campaign Report endpoint.

startDatestring

Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )

endDatestring

Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns. Prefer to pass your timezone in date-time format for accurate result ( only available if either 'status' not passed and if passed is set to 'sent' )

limitinteger

Number of documents per page

offsetinteger

Index of the first document in the page

sort'asc' | 'desc'

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

excludeHtmlContentboolean

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

Email campaigns informations

countinteger

Number of Email campaigns retrieved

Example response

{
  "campaigns": [
    {
      "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
        }
      }
    }
  ],
  "count": 24
}
All 233 operations