Return all your created email campaigns

GET

https://api.brevo.com/v3/emailCampaigns

GET

/v3/emailCampaigns

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.emailCampaigns.getEmailCampaigns({});
}
main();

{
  "campaigns": [
    {
      "id": 12,
      "name": "EN - Sales Summer 2017",
      "status": "sent",
      "type": "classic",
      "createdAt": "2017-05-01T12:30:00Z",
      "footer": "[DEFAULT_FOOTER]",
      "header": "[DEFAULT_HEADER]",
      "htmlContent": "This is my HTML Content",
      "modifiedAt": "2017-05-01T12:30:00Z",
      "replyTo": "replyto@domain.com",
      "sender": {
        "email": "marketing@mycompany.com",
        "id": 26,
        "name": "Marketing"
      },
      "testSent": true,
      "recipients": {
        "exclusionLists": [
          13
        ],
        "lists": [
          5
        ]
      },
      "statistics": {
        "campaignStats": [
          {
            "appleMppOpens": 10,
            "clickers": 2665,
            "complaints": 1,
            "delivered": 19765,
            "hardBounces": 87,
            "opensRate": 29.54,
            "sent": 19887,
            "softBounces": 100,
            "trackableViews": 5661,
            "uniqueClicks": 2300,
            "uniqueViews": 7779,
            "unsubscriptions": 2,
            "viewed": 8999,
            "deferred": 30,
            "listId": 5
          }
        ],
        "globalStats": {
          "appleMppOpens": 10,
          "clickers": 2665,
          "complaints": 1,
          "delivered": 19765,
          "hardBounces": 87,
          "opensRate": 29.54,
          "sent": 19887,
          "softBounces": 100,
          "trackableViews": 5661,
          "uniqueClicks": 2300,
          "uniqueViews": 7779,
          "unsubscriptions": 2,
          "viewed": 8999,
          "estimatedViews": 560,
          "trackableViewsRate": 23.45
        },
        "linksStats": {
          "http://myUrl1.domain.com": 80
        },
        "mirrorClick": 120,
        "remaining": 1000,
        "statsByDomain": {
          "hotmail.co.uk": {
            "clickers": 2720,
            "complaints": 5,
            "delivered": 117056,
            "hardBounces": 0,
            "sent": 117055,
            "softBounces": 111,
            "uniqueClicks": 1970,
            "uniqueViews": 21111,
            "unsubscriptions": 105,
            "viewed": 35251
          },
          "yahoo.com": {
            "clickers": 533,
            "complaints": 0,
            "delivered": 25596,
            "hardBounces": 0,
            "sent": 25601,
            "softBounces": 5,
            "uniqueClicks": 298,
            "uniqueViews": 3527,
            "unsubscriptions": 17,
            "viewed": 5255
          }
        }
      },
      "previewText": "Don't miss the sale!",
      "scheduledAt": "2017-06-01T12:30:00Z",
      "subject": "20% OFF for 2017 Summer Sales",
      "inlineImageActivation": true,
      "mirrorActive": true,
      "recurring": false,
      "shareLink": "http://example.com/fhsgccc.html?t=9865448900",
      "tag": "Newsletter",
      "toField": "{FNAME} {LNAME}"
    },
    {
      "id": 22,
      "name": "Weekly - 1",
      "status": "draft",
      "type": "classic",
      "createdAt": "2017-05-01T12:30:00Z",
      "footer": "[DEFAULT_FOOTER]",
      "header": "[DEFAULT_HEADER]",
      "htmlContent": "This is my HTML Content",
      "modifiedAt": "2017-05-01T12:30:00Z",
      "replyTo": "replyto@domain.com",
      "sender": {
        "email": "newsletter@mycompany.com",
        "id": 26,
        "name": "Newsletter"
      },
      "testSent": false,
      "recipients": {
        "exclusionLists": [
          45
        ],
        "lists": [
          10
        ]
      },
      "statistics": {
        "campaignStats": [
          {
            "appleMppOpens": 10,
            "clickers": 2665,
            "complaints": 1,
            "delivered": 19765,
            "hardBounces": 87,
            "opensRate": 29.54,
            "sent": 19887,
            "softBounces": 100,
            "trackableViews": 5661,
            "uniqueClicks": 2300,
            "uniqueViews": 7779,
            "unsubscriptions": 2,
            "viewed": 8999,
            "deferred": 30,
            "listId": 10
          }
        ],
        "globalStats": {
          "appleMppOpens": 10,
          "clickers": 2665,
          "complaints": 1,
          "delivered": 19765,
          "hardBounces": 87,
          "opensRate": 29.42,
          "sent": 19887,
          "softBounces": 100,
          "trackableViews": 5661,
          "uniqueClicks": 2300,
          "uniqueViews": 7779,
          "unsubscriptions": 2,
          "viewed": 8999,
          "estimatedViews": 560,
          "trackableViewsRate": 23.45
        },
        "linksStats": {
          "http://myUrl1.domain.com": {
            "nbClick": 80
          },
          "http://myUrl2.domain.com": {
            "nbClick": 80
          },
          "http://myUrl3.domain.com": {
            "nbClick": 80
          }
        },
        "mirrorClick": 120,
        "remaining": 1000,
        "statsByDomain": {
          "aol": {
            "clickers": 2665,
            "complaints": 1,
            "delivered": 19765,
            "hardBounces": 87,
            "sent": 19887,
            "softBounces": 100,
            "uniqueClicks": 2300,
            "uniqueViews": 7779,
            "unsubscriptions": 2,
            "viewed": 8999,
            "deferred": 30
          },
          "gmail": {
            "clickers": 2665,
            "complaints": 1,
            "delivered": 19765,
            "hardBounces": 87,
            "sent": 19887,
            "softBounces": 100,
            "uniqueClicks": 2300,
            "uniqueViews": 7779,
            "unsubscriptions": 2,
            "viewed": 8999,
            "deferred": 30
          }
        }
      },
      "attachmentFile": "http://img.mailinblue.com/{clientID-campaignID}/attachments/{fileName}",
      "previewText": "your weekly newsletter!",
      "scheduledAt": "",
      "subject": "Week 1 - Newsletter",
      "inlineImageActivation": true,
      "mirrorActive": true,
      "recurring": false,
      "shareLink": "http://example.com/fhsgccc.html?t=9865448900",
      "tag": "Newsletter",
      "tags": [
        "Newsletter",
        "Weekly"
      ],
      "toField": "{FNAME} {LNAME}"
    }
  ],
  "count": 2
}

The response payload for this endpoint has changed You now need to specify which type of statistics you would like to retrieve. For more information visit this page.

Authentication

api-keystring

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

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

typeenumOptional

Filter on the type of the campaigns

Allowed values:

statusenumOptional

Filter on the status of the campaign

statisticsenumOptional

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

Allowed values:

startDatestringOptional

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 status is not passed or is set to sent. The date range between startDate and endDate must not exceed 2 years. startDate must not be in the future.

endDatestringOptional

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 status is not passed or is set to sent. The date range between startDate and endDate must not exceed 2 years. endDate must not be in the future.

limitlongOptional1-100Defaults to 50

Number of documents per page

offsetlongOptionalDefaults to 0

Index of the first document in the page

sortenumOptionalDefaults to desc

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

Allowed values:

excludeHtmlContentbooleanOptional

Use this flag to exclude htmlContent from the response body. If set to true, the htmlContent field will be returned as an empty string in the response body.

excludePdfAttachmentbooleanOptional

Use this flag to filter out campaigns that have a PDF attachment. If set to true, only campaigns without a PDF attachment (or with no attachment at all) will be returned.

Response

Email campaigns information

campaignslist of objectsOptional

countlongOptional

Number of Email campaigns retrieved

Errors

400

Bad Request Error