removed
Get all Marketing Campaigns
about 2 years ago by Sendinblue
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 calledstatistics , 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:
globalStatslinksStatsstatsByDomain
Note
campaignStatswill always be returned by default.- This is a non breaking change. The nodes excluded from the
statisticsparameter will still be returned as empty nodes.
New request format
curl --request GET \
--url 'https://api.brevo.com/v3/emailCampaigns?statistics=globalStats&limit=50&offset=0&sort=desc' \
--header 'accept: application/json'
Response sample
{
"count": 2,
"campaigns": [
{
"id": 12,
"name": "EN - Sales Summer 2017",
"subject": "20% OFF for 2017 Summer Sales",
"previewText": "Don't miss the sale",
"type": "classic",
"status": "sent",
"scheduledAt": "2017-06-01T12:30:00Z",
"testSent": true,
"header": "[DEFAULT_HEADER]",
"footer": "[DEFAULT_FOOTER]",
"sender": {
"email": "[email protected]",
"name": "Marketing",
"id": 26
},
"replyTo": "[email protected]",
"toField": "{FNAME} {LNAME}",
"htmlContent": "This is my HTML Content",
"shareLink": "http://example.com/fhsgccc.html?t=9865448900",
"tag": "Newsletter",
"createdAt": "2017-05-01T12:30:00Z",
"modifiedAt": "2017-05-01T12:30:00Z",
"inlineImageActivation": true,
"mirrorActive": true,
"recurring": false,
"recipients": {
"lists": [
5
],
"exclusionLists": [
13
]
},
"statistics": {
"globalStats": {
"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
},
"campaignStats": [
{
"listId": 5,
"uniqueClicks": 2300,
"clickers": 2665,
"complaints": 1,
"delivered": 19765,
"sent": 19887,
"softBounces": 100,
"hardBounces": 87,
"uniqueViews": 7779,
"trackableViews": 5661,
"unsubscriptions": 2,
"viewed": 8999,
"deferred": 30
}
],
"mirrorClick": 120,
"remaining": 1000,
"linksStats": {
"http://myUrl1.domain.com": 80
},
"statsByDomain": {
"yahoo.com": {
"uniqueClicks": 298,
"clickers": 533,
"complaints": 0,
"sent": 25601,
"softBounces": 5,
"hardBounces": 0,
"uniqueViews": 3527,
"unsubscriptions": 17,
"viewed": 5255,
"delivered": 25596
},
"hotmail.co.uk": {
"uniqueClicks": 1970,
"clickers": 2720,
"complaints": 5,
"sent": 117055,
"softBounces": 111,
"hardBounces": 0,
"uniqueViews": 21111,
"unsubscriptions": 105,
"viewed": 35251,
"delivered": 117056
}
}
}
},
{
"id": 22,
"name": "Weekly - 1",
"subject": "Week 1 - Newsletter",
"previewText": "your weekly newsletter",
"type": "Classic",
"status": "draft",
"scheduledAt": "",
"testSent": false,
"header": "[DEFAULT_HEADER]",
"footer": "[DEFAULT_FOOTER]",
"sender": {
"email": "[email protected]",
"name": "Newsletter",
"id": 26
},
"replyTo": "[email protected]",
"toField": "{FNAME} {LNAME}",
"htmlContent": "This is my HTML Content",
"shareLink": "http://example.com/fhsgccc.html?t=9865448900",
"tag": "Newsletter",
"createdAt": "2017-05-01T12:30:00Z",
"modifiedAt": "2017-05-01T12:30:00Z",
"inlineImageActivation": true,
"mirrorActive": true,
"recurring": false,
"recipients": {
"lists": [
10
],
"exclusionLists": [
45
]
},
"statistics": {
"globalStats": {
"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
},
"campaignStats": [
{
"listId": 10,
"uniqueClicks": 2300,
"clickers": 2665,
"complaints": 1,
"delivered": 19765,
"sent": 19887,
"softBounces": 100,
"hardBounces": 87,
"uniqueViews": 7779,
"trackableViews": 5661,
"unsubscriptions": 2,
"viewed": 8999,
"deferred": 30
}
],
"mirrorClick": 120,
"remaining": 1000,
"linksStats": {
"http://myUrl1.domain.com": {
"nbClick": 80
},
"http://myUrl2.domain.com": {
"nbClick": 80
},
"http://myUrl3.domain.com": {
"nbClick": 80
}
},
"statsByDomain": {
"gmail": {
"uniqueClicks": 2300,
"clickers": 2665,
"complaints": 1,
"delivered": 19765,
"sent": 19887,
"softBounces": 100,
"hardBounces": 87,
"uniqueViews": 7779,
"unsubscriptions": 2,
"viewed": 8999,
"deferred": 30
},
"aol": {
"uniqueClicks": 2300,
"clickers": 2665,
"complaints": 1,
"delivered": 19765,
"sent": 19887,
"softBounces": 100,
"hardBounces": 87,
"uniqueViews": 7779,
"unsubscriptions": 2,
"viewed": 8999,
"deferred": 30
}
}
}
}
]
}