Detailed statistics
The detailed statistics return statistics at the finest level of detail. You will get one line per segment of campaign sent. For example, if your campaign has 2 segments and has been sent 2 times, you will get 4 lines of stats for this campaign.
3 endpoints allow you to get detailed statistics of your sendings:
- detailed statistics of the sendings of my database
- detailed statistics of my campaign sendings
- detailed statistics of a specific sending
Retrieve detailed statistics of all sendings
This api allows you to retrieve the statistics of all mailings made during the last X days on your Mindbaz idsite database.
The API call is as follows: api/{idsite}/statistics?mode={mode}&nbDays={nbDays}
The information to be passed in the url is the following and is all mandatory:
Name | Description | Type |
---|---|---|
mode | Filter on reading mode | ESentStatisticMode |
nbDays | nbDays max = 60 | Integer |
idsite | MindBaz site identifier | Integer |
With the mode being able to have as value :
Name | Value | Description |
---|---|---|
Mobile | 1 | Reading on mobile |
Desktop | 2 | Reading on PC |
DesktopAndMobile | 3 | Reading on PC and Mobile |
The return value of the call is as follows:
Name | Description | Type |
---|---|---|
data | Result of the webservice call | Collection of StatsGetSentsStatsV2Result |
error | Error message in case of failure | String |
success | Indicates success or failure of the webservice call | Boolean |
Data contains a collection of objects containing the detailed statistics of each segment sent (idSent) during the requested period.
Example
https://api.mindbaz.com/api/102/statistics?mode=2&nbDays=40
Return value:
{
"success": true,
"data": [
{
"campaignName": "[TEST FONC] FULL TEST mindgen1",
"endDate": "2021-07-16T14:42:10+02:00",
"idSent": 8994,
"mailObject": "[TEST REGIEPUB] Dynamiqué SHOT 5 [[FIELD.14]] [[FIELD.15]] (new) ★",
"nbAddressSent": 1,
"nbClickers": 0,
"nbClickersEdito": 0,
"nbClickersMirror": 0,
"nbClickersPub": 0,
"nbClickersUnsub": 0,
"nbClicks": 0,
"nbClicksEdito": 0,
"nbClicksMirror": 0,
"nbClicksPub": 0,
"nbClicksUnsub": 0,
"nbGodsons": 0,
"nbHardBounces": 0,
"nbNetworkBounces": 0,
"nbOpeners": 0,
"nbOpenings": 0,
"nbResponseBounces": 0,
"nbSoftBounces": 0,
"nbSpamBounces": 0,
"nbSpamComplaints": 0,
"nbUnsubs": 0,
"reac": 0.0,
"reacEdito": 0.0,
"reacMirror": 0.0,
"reacPub": 0.0,
"reacUnsub": 0.0,
"sendingName": "[TEST] glamour uniquement",
"startDate": "2021-07-16T14:42:09+02:00",
"idJob": 33489,
"idCampaign": 1183,
"campType": "newsletter",
"campMode": "simple",
"nbPubsInsert": 2,
"genSpeed": 4500,
"hasTxtMsg": true,
"idSending": 12929,
"sendingPosition": 1,
"isRandom": false,
"pctAddressChoosen": 100,
"idConfig": 1,
"configName": "default classification",
"expMail": "no-response@news.mindbaz.com",
"expName": "odéèisïo",
"responseMail": "no-response@oxygem.tv",
"responseName": "odéèisïo",
"idFilter": 1253,
"filterName": "[TEST] glamour uniquement",
"nbAddressToSend": 1,
"nbClicksViral": 0,
"nbClickersViral": 0,
"reacViral": 0.0
},
{
"campaignName": "[TEST FONC] FULL TEST mindgen1 [COPY] [COPY]20210719182018",
"endDate": "2021-07-19T20:30:03+02:00",
"idSent": 9003,
"mailObject": "[TEST REGIEPUB] Dynamiqué SHOT 5 [[FIELD.14]] [[FIELD.15]] (new) ★",
"nbAddressSent": 1,
"nbClickers": 0,
"nbClickersEdito": 0,
"nbClickersMirror": 0,
"nbClickersPub": 0,
"nbClickersUnsub": 0,
"nbClicks": 0,
"nbClicksEdito": 0,
"nbClicksMirror": 0,
"nbClicksPub": 0,
"nbClicksUnsub": 0,
"nbGodsons": 0,
"nbHardBounces": 0,
"nbNetworkBounces": 0,
"nbOpeners": 0,
"nbOpenings": 0,
"nbResponseBounces": 0,
"nbSoftBounces": 0,
"nbSpamBounces": 0,
"nbSpamComplaints": 0,
"nbUnsubs": 0,
"reac": 0.0,
"reacEdito": 0.0,
"reacMirror": 0.0,
"reacPub": 0.0,
"reacUnsub": 0.0,
"sendingName": "[TEST] glamour uniquement",
"startDate": "2021-07-19T20:30:03+02:00",
"idJob": 33498,
"idCampaign": 10887,
"campType": "newsletter",
"campMode": "simple",
"nbPubsInsert": 2,
"genSpeed": 4500,
"hasTxtMsg": true,
"idSending": 12940,
"sendingPosition": 1,
"isRandom": false,
"pctAddressChoosen": 100,
"idConfig": 1,
"configName": "default classification",
"expMail": "no-response@news.mindbaz.com",
"expName": "odéèisïo",
"responseMail": "no-response@oxygem.tv",
"responseName": "odéèisïo",
"idFilter": 1253,
"filterName": "[TEST] glamour uniquement",
"nbAddressToSend": 1,
"nbClicksViral": 0,
"nbClickersViral": 0,
"reacViral": 0.0
},
...
],
"error": null,
"typeName": "StatsGetSentsStatsV2Result[]"
}
Retrieving detailed statistics of a campaign sendings
This request, unlike the previous one, will target the sendings of a single campaign. The API call is as follows: api/{idsite}/statistics/campaigns?idCampaign={idCampaign}&mode={mode}&nbDays={nbDays}
The information to be passed in the url are the following and are all mandatory:
Name | Description | Type |
---|---|---|
idCampaign | Id of the campaign | Integer |
mode | reading mode filter | ESentStatisticMode |
nbDays | nbDays max = 60 | Integer |
idsite | MindBaz site identifier | Integer |
The return value of the call is the same as the previous one, but only the sendings of the campaign passed in parameter will be returned.
Name | Description | Type |
---|---|---|
data | Result of the call to the webservice | Collection of StatsGetSentsStatsV2Result |
error | Error message in case of failure | String |
success | Indicates the success or failure of the webservice call | Boolean |
typeName | Type of data contained in the Data field | String |
Example
https://api.mindbaz.com/api/102/statistics/campaigns?idCampaign=10395&mode=2&nbDays=40
Return value :
(here, there is no result, so data is an empty collection, but otherwise the data collection is identical to the one of the request to retrieve the sending statistics described before)
{
"success": true,
"data": [],
"error": null,
"typeName": "StatsGetSentsStatsV2Result[]"
}
Detailed statistics of a single sending
This query allows you to retrieve the statistics of a single sent segment.
The id of the sent segment (idSent) must therefore be specified for this call. This is as follows: api/{idsite}/statistics/sents?idSent={idSent}&mode={mode}
The information to be passed in the url are the following and are all mandatory:
Name | Description | Type |
---|---|---|
idSent | Id of the segment sent | Integer |
mode | filter on reading mode | ESentStatisticMode |
idsite | MindBaz site id | Integer |
The return value of the call is as follows:
Name | Description | Type |
---|---|---|
data | Result of the call to the webservice | Collection of SentStatistics |
error | Error message in case of failure | String of characters |
success | Indicates the success or not of the call to the webservice | Boolean |
typeName | Type of data contained in the Data field | String |
Data contains a collection of a single object containing the statistics of the requested sending.
Example
https://api.mindbaz.com/api/102/statistics/sents?idSent=8994&mode=2
Return value:
{
"success": true,
"data": [
{
"campaignName": "[TEST FONC] FULL TEST mindgen1",
"endDate": "2021-07-16T14:42:10+02:00",
"idSent": 8994,
"mailObject": "[TEST REGIEPUB] Dynamiqué SHOT 5 [[FIELD.14]] [[FIELD.15]] (new) ★",
"nbAddressSent": 1,
"nbClickers": 0,
"nbClickersEdito": 0,
"nbClickersMirror": 0,
"nbClickersPub": 0,
"nbClickersUnsub": 0,
"nbClicks": 0,
"nbClicksEdito": 0,
"nbClicksMirror": 0,
"nbClicksPub": 0,
"nbClicksUnsub": 0,
"nbGodsons": 0,
"nbHardBounces": -2147483648,
"nbNetworkBounces": -2147483648,
"nbOpeners": 0,
"nbOpenings": 0,
"nbResponseBounces": -2147483648,
"nbSoftBounces": -2147483648,
"nbSpamBounces": -2147483648,
"nbSpamComplaints": 0,
"nbUnsubs": 0,
"reac": 0.0,
"reacEdito": 0.0,
"reacMirror": 0.0,
"reacPub": 0.0,
"reacUnsub": 0.0,
"sendingName": "[TEST] glamour uniquement",
"startDate": "2021-07-16T14:42:09+02:00"
}
],
"error": null,
"typeName": "SentStatistics[]"
}