removed

Get all Marketing Campaigns

We are modifying the get all marketing campaigns service to be more efficient. It currently fetches multiple statistical information which adds latency to the endpoint response.

To provide a more accurate payload we are adding a new querying parameter called statistics , for which you will specify what data you are aiming to fetch.

If you need more than one of the following collections please make multiple calls to the endpoint in order to retrieve them:

  • globalStats
  • linksStats
  • statsByDomain
  • statsByDevice
  • statsByBrowser

📘

Note

  • campaignStats will always be returned by default.
  • This is a non breaking change. The nodes excluded from the statistics parameter will still be returned as empty nodes.

New request format

curl --request GET \
     --url 'https://api.sendinblue.com/v3/emailCampaigns?limit=50&offset=0&statistics=linksStats' \
     --header 'accept: application/json'

Response sample

"statistics": {
        "globalStats": {
            "uniqueClicks": 0,
            "clickers": 0,
            "complaints": 0,
            "delivered": 0,
            "sent": 0,
            "softBounces": 0,
            "hardBounces": 0,
            "uniqueViews": 0,
            "trackableViews": 0,
            "trackableViewsRate": 0,
            "estimatedViews": 0,
            "unsubscriptions": 0,
            "viewed": 0
        },
        "campaignStats": [
            {
                "listId": 30,
                "uniqueClicks": 24,
                "clickers": 140,
                "complaints": 10,
                "delivered": 20,
                "sent":11000,
                "softBounces": 3,
                "hardBounces": 12,
                "uniqueViews": 2561,
                "trackableViews": 5125,
                "unsubscriptions": 245,
                "viewed":3450,
                "deferred": 150
            }
        ],
        "mirrorClick": 0,
        "remaining": 0,
        "linksStats": {
            "http://myUrl1.domain.com": {
                "nbClick": 130
            },
            "http://myUrl2.domain.com": {
                "nbClick": 80
            },
            "http://myUrl3.domain.com": {
                "nbClick": 80
            }
        },
        "statsByDomain": {},
        "statsByDevice": {},
        "statsByBrowser": {}
    }
}