Les statistiques détaillées

Les statistiques détaillées retournes les statistiques au niveau de détail le plus fin. Vous obtiendrez une ligne par segment de campagne envoyée. Par exemple, si votre campagne possède 2 segments et si elle a été envoyé 2 fois, vous obtiendrez 4 lignes de stats pour cette campagne.

3 endpoints vous permettent de récupérer des statistiques détaillées de vos envois :

Récupération des statistiques détaillées de tous envois

Cette api permet de récupérer les statistiques de tous les envois effectués pendant les X derniers jours sur votre base Mindbaz idsite.
L'appel API est le suivant : api/{idsite}/statistics?mode={mode}&nbDays={nbDays}

Les informations à passer dans l'url sont les suivantes et sont toutes obligatoires :

Nom	Description	Type
mode	Filtre sur le mode de lecture	ESentStatisticMode
nbDays	nbDays max = 60	Nombre entier
idsite	Identifiant de site MindBaz	Nombre entier

Avec le mode pouvant avoir comme valeur :

Nom	Valeur	Description
Mobile	1	Lecture sur mobile
Desktop	2	Lecture sur PC
DesktopAndMobile	3	Lecture sur PC et mobile

La valeur de retour de l'appel est le suivant :

Nom	Description	Type
data	Résultat de l'appel au webservice	Collection de StatsGetSentsStatsV2Result
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 contient une collection d'objets contenant les statistiques détaillées de chaque segments envoyés (idSent) pendant la période demandée.

Exemple

https://api.mindbaz.com/api/102/statistics?mode=2&nbDays=40

Valeur de retour :

{
  "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[]"
}

Récupération des statistiques détaillées des envois d’une campagne

Cette requête à la différence de la précédente va cibler les envois d'une seule campagne.
L'appel API est le suivant : api/{idsite}/statistics/campaigns?idCampaign={idCampaign}&mode={mode}&nbDays={nbDays}

Les informations à passer dans l'url sont les suivantes et sont toutes obligatoires :

Nom	Description	Type
idCampaign	Id de la campagne	Nombre entier
mode	Filtre sur le mode de lecture	ESentStatisticMode
nbDays	nbDays max = 60	Nombre entier
idsite	Identifiant de site MindBaz	Nombre entier

La valeur de retour de l'appel est le même que le précédent mais seul les envois de la campagne passée en paramètre seront retournés.

Nom	Description	Type
data	Résultat de l'appel au webservice	Collection de StatsGetSentsStatsV2Result
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

Exemple

https://api.mindbaz.com/api/102/statistics/campaigns?idCampaign=10395&mode=2&nbDays=40

Valeur de retour :

(ici, il n'y a aucun résultat, data est donc une collection vide, mais sinon la collection data est identique à celle de la requête de récupération les statistiques des envois décrite auparavant)

{
    "success": true,
    "data": [],
    "error": null,
    "typeName": "StatsGetSentsStatsV2Result[]"
}

Récupérer les statistiques d'un envoi

Cette requête permet de récupérer les statistiques d'un seul envoi de segment.
Il faut donc préciser l'id du segment envoyé (idSent) pour cet appel. Ce dernier est le suivant : api/{idsite}/statistics/sents?idSent={idSent}&mode={mode}

Les informations à passer dans l'url sont les suivantes et sont toutes obligatoires :

Nom	Description	Type
idSent	Id de l'envoi	Nombre entier
mode	Filtre sur le mode de lecture	ESentStatisticMode
idsite	Identifiant de site MindBaz	Nombre entier

La valeur de retour de l'appel est le suivant :

Nom	Description	Type
data	Résultat de l'appel au webservice	Collection de SentStatistics
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 contient une collection d'un seul objet contenant les statistiques de l'envoi demandé.

Exemple

https://api.mindbaz.com/api/102/statistics/sents?idSent=8994&mode=2

Valeur de retour :

{
    "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[]"
}

Récupération des statistiques détaillées de tous envois​

Exemple​

Récupération des statistiques détaillées des envois d’une campagne​

Exemple​

Récupérer les statistiques d'un envoi​

Exemple​

Récupération des statistiques détaillées de tous envois

Exemple

Récupération des statistiques détaillées des envois d’une campagne

Exemple

Récupérer les statistiques d'un envoi

Exemple