Les statistiques agrégées
Les statistiques agrégées représente la somme des indicateurs (ouvertures, clics...) sur une seule ligne de résultat. Par exemple, les ouvertures des statistiques agrégées d'une campagne sont la somme de toutes les ouvertures de tous les envois et de tous les segments.
2 endpoints vous permettent de récupérer des statistiques agrégées :
Récupérer les statistiques de ma campagne
Pour récupérer les statistiques d’une campagne via l'API Mindbaz, l'appel suivant est disponible : GET api/{idsite}/statistics/campaign?idCampaign={idCampaign}
Si votre campagne a été envoyé plusieurs fois, vous obtiendrez les statistiques agrégées de tous ses envois.
Les informations à passer dans l'url sont les suivantes et sont toutes obligatoires :
Nom | Description | Type |
---|---|---|
idCampaign | Id de la campagne | Nombre entier |
idsite | Identifiant de site MindBaz | Nombre entier |
La valeur de retour de l'appel est la suivante :
Nom | Description | Type |
---|---|---|
data | Résultat de l'appel au webservice | StatsGetFullStatsResult |
error | Message d'erreur en cas d'échec | Chaine de caractères |
success | Indique le succès ou non de l'appel au webservice | Booléen |
typeName | Type de données contenues dans le champ Data | Chaine de caractères |
Data est un objet contenant les statistiques de la campagne.
Exemple
https://api.mindbaz.com/api/100/statistics/campaign?idCampaign=8826
Valeur de retour :
{
"success": true,
"data": {
"groupName" : "Mindbaz",
"jobErrorInfo" : "",
"nbAd" : 2,
"nbAdClickers" : 0,
"nbAdClicks" : 0,
"nbAddressSent" : 688,
"nbAddressToSend" : 694,
"nbAutoRespondersBounces" : 0,
"nbClickers" : 471,
"nbClicks" : 471,
"nbDnsErrorsBounces" : 0,
"nbEditoClickers" : 462,
"nbEditoClicks" : 462,
"nbGodsons" : 0,
"nbHardBounces" : 337,
"nbHumanOpeners" : 2054,
"nbHumanOpenings" : 3078,
"nbjob" : 353,
"nbLinks" : 3865,
"nbMirrorClickers" : 9,
"nbMirrorClicks" : 9,
"nbOpeners" : 2160,
"nbOpenings" : 3370,
"nbSents" : 353,
"nbSoftBounces" : 337,
"nbSpamBounces" : 338,
"nbSpamComplaints" : 0,
"nbTotalBounces" : 1012,
"nbUnsubClickers" : 0,
"nbUnsubClicks" : 0,
"nbUnsubs" : 0,
"nbViralClicks" : 0,
"senderDomain" : "news.mindbaz.com"
},
"error": null,
"typeName": "StatsGetFullStatsResult"
}
Explication des métriques
Nom | Description |
---|---|
nbAddressSent | nombre d’emails envoyés |
nbAddressToSend | nombre d’emails ciblés par le segment |
nbOpenings | nombre d’ouvertures |
nbOpeners | nombre d’ouvreurs uniques (un email qui a ouvert plusieurs fois est compté qu’une fois) |
nbHumanOpenings | nombre d’ouvertures “humaines” c’est à dire sans prendre en compte les ouvertures faites automatiquement par les serveurs Apple (cf Apple MPP pour plus d’infos) |
nbHumanOpeners | nombre d’ouvreurs “humains” uniques |
nbClicks | nombre de clics |
nbClickers | nombre de cliqueurs uniques |
nbEditoClicks | nombre de clics sur des liens editoriaux |
nbEditoClickers | nombre de cliqueurs uniques ayant cliqué sur des liens editoriaux |
nbAdClicks | nombre de clics sur les liens pub |
nbAdClickers | nombre de cliqueurs uniques ayant cliqué sur des liens pub |
nbMirrorClicks | nombre de clics sur des liens page miroir |
nbMirrorClickers | nombre de cliqueurs uniques sur des liens de page miroir |
nbUnsubClicks | nombre de clics sur des liens de désabonnement |
nbUnsubClickers | nombre de cliqueurs uniques sur des liens de désabonnnement |
nbTotalBounces | nombre total de tous les NPAIs |
nbHardBounces | nombre de NPAI de type “Hardbounce” |
nbDnsErrorsBounces | nombre de NPAI de type “Erreur réseau” |
nbAutoRespondersBounces | nombre de NPAI de type “Réponse automatique” |
nbSoftBounces | nombre de NPAI de type “Softbounce” |
nbSpamBounces | nombre de NPAI de type “Spam” |
nbSpamComplaints | nombre de plaintes reçues grâce aux feedbackloop avec certains ISP |
nbUnsubs | nombre de désabonnements (list-unsubscribe + liens) |
nbViralClicks | nombre de clics sur liens envoyer à un ami (obsolete) |
nbGodsons | nombre de parrains ayant générer un nouvel abonné (obsolete) |
nbjob | nombre de fois que la campagne a été envoyée |
nbSents | nombre de segments envoyés |
nbAd | nombre de publicités |
nbLinks | nombre de liens |
groupNam | nom du groupe d’ips utilisé pour l’envoi |
jobErrorInfo | dernier message d’erreur de l’envoi |
senderDomain | domaine expéditeur utilisé par la campagne |
Récupérer les statistiques par fai d’un envoi
Pour récupérer les statistiques par fai d’une campagne, l'api suivante est disponible : GET api/{idsite}/statistics/fai?idJob={idJob}&idSent={idSent}
L’api prend en paramètre dans la query soit l’idJob soit l’idSent.
Nom | Description | Type |
---|---|---|
idJob | Identifiant du job | Nombre entier |
idSent | Identifiant de l'envoi | Nombre entier |
idsite | Identifiant de site MindBaz | Nombre entier |
Pour connaître la liste des identifiants idJob et idSent de votre campagne, vous pouvez faire un GET sur api/{idsite}/sents/light?idCampaign={idCampaign}
Vous récupérerez alors la liste des segments envoyés dans le tableau data->sent avec leurs informations les plus importantes : idsent, idJob, idsending, dates de début et de fin, nom de la cible et s’il s’agit d’un envoi test.
Cette api fait un top 10 des fai rencontrés lors d’ un envoi de la campagne et retourne les statistiques aggrégées pour chaque FAI. Un fai “autre” est retourné automatiquement pour regrouper tous les fais et domaines avec un petit volume.
La valeur de retour de l'appel est la suivante :
Nom | Description | Type |
---|---|---|
data | Résultat de l'appel au webservice | Collection de StatsGetSentFaiResult |
error | Message d'erreur en cas d'échec | Chaine de caractères |
success | Indique le succès ou non de l'appel au webservice | Booléen |
typeName | Type de données contenues dans le champ Data | Chaine de caractères |
Data est une collection d'objets contenant les statistiques par fai de la campagne.
Exemple
https://api.mindbaz.com/api/102/statistics/fai?idJob=13287411&idSent=1206
Valeur de retour :
{
"success": true,
"data": [
{
"groupName" : "Mindbaz",
"idFai": 0,
"isp": "m6.fr",
"nbAddressToSend": 50,
"nbAddressSent": 50,
"nbBounces": 9,
"nbDelivered": 41,
"nbHardBounces": 9,
"nbSoftBounces": 0,
"nbAutoRespondersBounces": 0,
"nbDnsErrorsBounces": 0,
"nbSpamBounces": 0,
"dsnCount": 9,
"nbOpenings": 211,
"nbOpeners": 20,
"nbHumanOpenings":160,
"nbHumanOpeners":15,
"nbClicks": 0,
"nbClickers": 0,
"nbUnsubClicks": 0,
"nbMirrorClicks": 0,
"nbEditoClicks": 0,
"nbAdClicks": 0,
"nbViralClicks": 0,
"nbSpamComplaints": 0,
"dsn": "\r\nAction=failed;Status=5.1.1;Diagnostic-Code: 5.1.1 - Bad destination email address 'reject' (delivery attempts: 0)",
"dsnCount": 5,
"nbContentClickers": 0,
"nbAdClickers": 0,
"nbEditoClickers": 0,
"nbMirrorClickers": 0,
"nbUnsubClickers": 0,
"nbViralClickers": 0,
"nbUnsubs": 0
}
],
"error": null,
"typeName": "StatsGetSentFaiResult[]"
}
Explication des métriques
De champs additionnels apparaissent dans cette api :
Nom | Description |
---|---|
dsn | Delivery Status Notification - message d’erreur d’envoi le plus fréquent |
dsnCount | nombre de fois que le dsn ci-dessus a été retourné |
idFai | id du fai ou -1 pour le fai “Autre” ou 0 pour un fai inconnu |
isp | nom du fai ou nom de domaine si le fai n’est pas connu (idFai=0) |