Statistiques des messages

messages:list

Affiche la liste des messages envoyés.

POST https://api.pushwoosh.com/api/v2/messages:list

En-têtes

Nom	Requis	Description
`Authorization`	Oui	Jeton d’API du serveur. Doit être fourni dans le format suivant : `Authorization: Api <Server Key>`.

Paramètres du corps de la requête

Nom	Requis	Type	Description
`platforms`	Non	Array	Plateformes des messages. Valeurs possibles : `"IOS"`, `"ANDROID"`, `"OSX"`, `"WINDOWS"`, `"AMAZON"`, `"SAFARI"`, `"CHROME"`, `"FIREFOX"`, `"IE"`, `"EMAIL"`, `"HUAWEI_ANDROID"`, `"SMS"`.
`date_range`	Non	Object	Période de rapport. `date_from` et `date_to` doivent suivre le format `AAAA-MM-JJ` (par ex., `"2000-01-01"`).
`campaign`	Non	String	Code de campagne
`filters`	Oui	Object	Filtres de message.
`source`	Non	String	Source du message. Par exemple : `AB_TEST`, `API`, `AUTO_PUSH`, `CP`, `CSV`, `CUSTOMER_JOURNEY`, `EMAIL_API`, `EMAIL_CP`, `GEO_ZONE`, `PUSH_ON_EVENT`, `RSS`.
`messages_codes`	Non	Array	Codes de message obtenus à partir des réponses de l’API `/createMessage`.
`messages_ids`	Non	Array	ID de message obtenus à partir de l’historique des messages
`params`	Non	Object	Spécifiez s’il faut afficher les détails et les métriques du message. Définissez `with_details: true` pour inclure l’objet `"details"` et `with_metrics: true` pour inclure l’objet `"metrics"` dans la réponse.
`application`	Oui	String	Code d’application Pushwoosh.
`per_page`	Non	Integer	Nombre de résultats par page (≤ 1000).
`page`	Non	Integer	Numéro de page pour la pagination. Voir la limite de pagination profonde ci-dessous.

Exemple de requête

{
    "filters": {
      "platforms": [],                  // IOS, ANDROID, OSX, WINDOWS, AMAZON, SAFARI, CHROME, FIREFOX, IE, EMAIL, HUAWEI_ANDROID, SMS
      "date_range": {
        "date_from": "string",          // Format requis : 2000-01-01
        "date_to": "string"             // Format requis : 2000-01-01
      },
      "source": "API",                  // AB_TEST, API, AUTO_PUSH, CP, CSV, CUSTOMER_JOURNEY, EMAIL_API, EMAIL_CP, GEO_ZONE, PUSH_ON_EVENT, RSS
      "campaign": "string",             // Code de campagne
      "messages_ids": [],               // ID de message
      "messages_codes": [],             // Codes de message
      "application": "string"           // Code d'application Pushwoosh
    },
    "params": {
      "with_details": true,             // Ajouter les détails du message à la réponse (objet "details")
      "with_metrics": true              // Ajouter les métriques du message à la réponse (objet "metrics")
    },
    "per_page": 20,                     // <= 1000
    "page": 0
}

Codes de réponse et exemples

{
  "total": 0,
  "items": [{
    "id": 0,
    "code": "string",
    "created_date": "string",
    "send_date": "string",
    "status": "string",
    "platforms": [],
    "source": "string",
    "push_info": {
      "details": {
        "title": "string",
        "filter_name": "string",
        "filter_code": "string",
        "content": {
          "key": "value"
        },
        "platform_parameters": {
          "android_header": "string",
          "android_root_params": {
            "key": "value"
          },
          "ios_title": "string",
          "ios_subtitle": "string",
          "ios_root_params": {
            "key": "value"
          },
          "chrome_header": "string",
          "chrome_root_params": {
            "key": "value"
          },
          "firefox_header": "string",
          "firefox_root_params": {
            "key": "value"
          },
          "conditions": [               // conditions de tag (voir /developer/api-reference/messages-api/#tag-conditions)
            TAG_CONDITION1,
            TAG_CONDITION2,
            ...,
            TAG_CONDITIONN
          ],
          "conditions_operator": "AND", // opérateur logique pour les tableaux de conditions ; valeurs possibles : AND, OR
          "data": {
            "key": "value"
          }
        },
        "follow_user_timezone": true
      },
      "metrics": [{
        "sends": 0,
        "opens": 0,
        "deliveries": 0,
        "inbox_opens": 0,
        "unshowable_sends": 0,
        "errors": 0,
        "platform": 0
      }]
    },
    "email_info": {
      "details": {
        "template": "string",
        "filter_name": "string",
        "filter_code": "string",
        "subject": {
          "key": "value"
        },
        "from_name": "string",
        "from_email": "string",
        "reply_name": "string",
        "reply_email": "string",
        "follow_user_timezone": true,
        "conditions": [              // conditions de tag (voir Messages-api - tag-conditions)
          TAG_CONDITION1,
          TAG_CONDITION2,
          ...,
          TAG_CONDITIONN
        ],
        "conditions_operator": "AND" // opérateur logique pour les tableaux de conditions ; valeurs possibles : AND, OR
      },
      "metrics": [{
        "sends": 0,
        "opens": 0,
        "deliveries": 0,
        "hard_bounces": 0,
        "soft_bounces": 0,
        "rejects": 0,
        "confirmed_sends": 0,
        "unsubs": 0,
        "complaints": 0,
        "errors": 0
      }]
    }
  }]
}

La date_range s’étend sur plus de 30 jours :

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

page × per_page dépasse la limite de pagination profonde :

{
  "error": "requested result window is too large, narrow the date range"
}

{
  "error": "account not found"
}

totalsByIntervals

Renvoie les métriques et les données de conversion basées sur le code du message, agrégées par heure.

POST https://api.pushwoosh.com/api/v2/statistics/messages/totalsByIntervals

Autorisation

L’autorisation est gérée via le jeton d’accès API dans l’en-tête de la requête.

Paramètres du corps de la requête

Nom du paramètre	Type	Description	Requis
`message_code`	string	Code de message obtenu à partir des réponses de l’API `/createMessage`.	Oui
`platforms`	[int]	Plateformes	Non

Exemple de requête

{
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // requis. Identifiant unique du message
  "platforms": [1, 3, 7, 10, 11, 12]          // optionnel. Liste des codes de plateforme
}

Champs de la réponse

Nom	Type	Description
`metrics`	array	Contient un tableau de métriques de message
`timestamp`	string	L’heure de la métrique.
`platform`	int	Le code de la plateforme (par ex., iOS, Android).
`sends`	string	Le nombre de messages envoyés.
`opens`	string	Le nombre de messages ouverts.
`deliveries`	string	Le nombre de messages livrés.
`inbox_opens`	string	Le nombre d’ouvertures de la boîte de réception.
`unshowable_sends`	string	Le nombre de messages envoyés qui n’ont pas pu être affichés.
`errors`	string	Le nombre d’erreurs.
`conversion`	object	Contient les données de conversion
`sends`	string	Le nombre total de messages envoyés.
`opens`	string	Le nombre total de messages ouverts.
`events`	array	Un tableau d’événements avec leurs statistiques
`name`	string	Le nom de l’événement (par ex., ajout au panier).
`hits`	string	Le nombre de hits.
`conversion`	float	Le taux de conversion par rapport aux ouvertures.
`revenue`	float	Le revenu (uniquement pour les événements avec les attributs `__amount` et `__currency`).

Exemple de réponse

{
  "metrics": [{
    "timestamp": "2024-08-03 15:00:00",  // Horodatage des métriques au format "AAAA-MM-JJ HH:MM:SS"
    "platform": 3,                       // Code de la plateforme
    "sends": "55902",                    // Nombre de messages envoyés
    "opens": "382",                      // Nombre de messages ouverts
    "deliveries": "22931",               // Nombre de messages livrés
    "inbox_opens": "0",                  // Nombre de messages ouverts dans la boîte de réception
    "unshowable_sends": "2",             // Nombre de messages qui n'ont pas pu être affichés
    "errors": "0"                        // Nombre d'erreurs rencontrées
  }],
  "conversion": {
    "sends": "55902",                    // Nombre total de messages envoyés
    "opens": "772",                      // Nombre total de messages ouverts
    "events": [{
      "name": "cart_add",                // Nom de l'événement
      "hits": "96",                      // Nombre de hits pour l'événement
      "conversion": 0.12,                // Taux de conversion par rapport aux ouvertures
      "revenue": 0                       // Revenu généré par l'événement (uniquement pour les événements avec des attributs de montant/devise)
    }]
  }
}

getDeliveryFunnel

Renvoie l’entonnoir de livraison pour un seul message : audience → envoyé → réussi → livré → ouvertures, avec une ventilation des pertes d’audience à chaque étape.

POST https://api.pushwoosh.com/api/v2/statistics/messages/getDeliveryFunnel

En-têtes

Nom	Requis	Description
`Authorization`	Requis	Jeton d’accès API depuis le panneau de contrôle Pushwoosh.

Paramètres du corps de la requête

Nom	Requis	Type	Description
`message_code`	Oui	String	Code de message obtenu à partir des réponses de l’API `/createMessage`.
`timestamp_from`	Oui	String (RFC 3339 date-time)	Début de la plage de temps du rapport, par ex. `"2026-08-01T00:00:00Z"`. Doit être antérieur à `timestamp_to`.
`timestamp_to`	Oui	String (RFC 3339 date-time)	Fin de la plage de temps du rapport, par ex. `"2026-08-04T00:00:00Z"`.
`platforms`	Non	Array of Integer	Filtre optionnel par ID de plateforme.

Exemple de requête

{
  "message_code": "A444-AAABBBCC-00112233",  // requis, code de message obtenu à partir de la réponse /createMessage
  "timestamp_from": "2026-08-01T00:00:00Z",  // requis, doit être avant timestamp_to
  "timestamp_to": "2026-08-04T00:00:00Z",    // requis
  "platforms": [1, 3, 7]                     // optionnel, liste des codes de plateforme
}

Champs de la réponse

Nom	Type	Description
`funnel`	array	Étapes de l’entonnoir, toujours retournées dans cet ordre : `STAGE_AUDIENCE`, `STAGE_SENT`, `STAGE_SUCCESSFUL`, `STAGE_DELIVERED`, `STAGE_OPENS`.
`stage`	string	Nom de l’étape de l’entonnoir.
`count`	string	Nombre total pour l’étape.
`pieces`	array	Ventilation de `count` en catégories. Une catégorie avec un nombre nul est omise plutôt que retournée comme `0`.
`pieces[].kind`	string	Comment la pièce se rapporte au total de l’étape : `KIND_PASSED` (passé à l’étape suivante), `KIND_REASON` (abandonné pour cette raison), ou `KIND_SUBSET` (partie de l’étape, pas un sommant séparé).
`pieces[].category`	string	Catégorie de ventilation, par ex. `INVALID_TOKEN`, `FREQUENCY_CAPPING`, `CONTROL_GROUP` — voir le tableau des étapes ci-dessous.
`pieces[].count`	string	Nombre pour cette catégorie.

Étapes de l’entonnoir

Étape	Signification de `count`	`pieces`
`STAGE_AUDIENCE`	Appareils pris en traitement.	`KIND_PASSED` `ELIGIBLE_AUDIENCE` (passé à `STAGE_SENT`) ; `KIND_REASON` : `FREQUENCY_CAPPING`, `CONTROL_GROUP`, `UNSUBSCRIBED`, `BOUNCED`, `COMPLAINT`, `FILTERED_BY_CATEGORY`
`STAGE_SENT`	La livraison a été tentée.	`KIND_PASSED` `SUCCESSFUL` (accepté par le fournisseur) ; `KIND_REASON` : `INVALID_TOKEN`, `NO_TOKEN`, `NO_DEVICE`, `PLATFORM_DISABLED`, `QUOTA_EXCEEDED`, `INVALID_CONTENT`, `INVALID_CONFIGURATION`, `INTERNAL_ERROR`, `PROVIDER_ERROR` (erreurs de fournisseur non catégorisées)
`STAGE_SUCCESSFUL`	Accepté par le fournisseur.	`KIND_PASSED` `SHOWABLE` ; `KIND_REASON` `NOTIFICATIONS_DISABLED`
`STAGE_DELIVERED`	Appareils uniques ayant confirmé la livraison.	aucun
`STAGE_OPENS`	Appareils uniques ayant ouvert.	`KIND_SUBSET` `MACHINE_OPENS_AMPP` (ouvertures déclenchées par l’automatisation AMP, pas une ouverture réelle par un utilisateur)

Exemple de réponse

{
  "funnel": [
    {
      "stage": "STAGE_AUDIENCE",
      "count": "600000",
      "pieces": [
        { "kind": "KIND_PASSED", "category": "ELIGIBLE_AUDIENCE", "count": "580000" },
        { "kind": "KIND_REASON", "category": "FREQUENCY_CAPPING", "count": "14000" },
        { "kind": "KIND_REASON", "category": "CONTROL_GROUP", "count": "6000" }
      ]
    },
    {
      "stage": "STAGE_SENT",
      "count": "580000",
      "pieces": [
        { "kind": "KIND_PASSED", "category": "SUCCESSFUL", "count": "560000" },
        { "kind": "KIND_REASON", "category": "INVALID_TOKEN", "count": "18000" },
        { "kind": "KIND_REASON", "category": "PROVIDER_ERROR", "count": "2000" }
      ]
    },
    {
      "stage": "STAGE_SUCCESSFUL",
      "count": "560000",
      "pieces": [
        { "kind": "KIND_PASSED", "category": "SHOWABLE", "count": "540000" },
        { "kind": "KIND_REASON", "category": "NOTIFICATIONS_DISABLED", "count": "20000" }
      ]
    },
    {
      "stage": "STAGE_DELIVERED",
      "count": "168316",
      "pieces": []
    },
    {
      "stage": "STAGE_OPENS",
      "count": "30514",
      "pieces": [
        { "kind": "KIND_SUBSET", "category": "MACHINE_OPENS_AMPP", "count": "412" }
      ]
    }
  ]
}

Codes de réponse et exemples

{
  "funnel": []
}

{
  "error": "message_code must be set"
}

Également retourné comme "invalid date range: timestamp_from must be before timestamp_to" lorsque la plage est inversée ou vide.

{
  "error": "account not found"
}

{
  "error": "message not found"
}

getMessageLog

Affiche des informations détaillées sur les messages envoyés.

POST https://api.pushwoosh.com/api/v2/statistics/getMessageLog

En-têtes

Nom	Requis	Description
`Authorization`	Requis	Jeton d’accès API depuis le panneau de contrôle Pushwoosh.

Paramètres du corps de la requête

Nom	Requis	Type	Description
`message_id`	Non	Integer	Sélectionner les événements de messages par ID de message obtenu à partir de l’historique des messages. Exemple : `12345678900`.
`message_code`	Non	String	Sélectionner les événements de messages par Code de message obtenu à partir des réponses de l’API `/createMessage`. Exemple : `"A444-AAABBBCC-00112233"`.
`campaign_code`	Non	String	Sélectionner les événements de messages par Code de campagne spécifié dans la charge utile de votre message. Exemple : `"AAAAA-XXXXX"`.
`hwid`	Non	String or Array	Sélectionner les événements de messages par HWID (Hardware ID) ou un tableau de HWID.
`date_from`	Requis si `message_id`, `message_code`, ou `campaign_code` n’est pas fourni	Datetime	Date de début pour le filtrage des messages. Format : `"AAAA-MM-JJ HH:MM:SS"`. Exemple : `"2000-01-25 00:00:00"`.
`date_to`	Requis si `message_id`, `message_code`, ou `campaign_code` n’est pas fourni	Datetime	Date de fin pour le filtrage des messages. Format : `"AAAA-MM-JJ HH:MM:SS"`. Exemple : `"2000-01-26 00:00:00"`.
`limit`	Non	Integer	Nombre maximal d’événements de message retournés dans une seule réponse. Valeur maximale : `100000`.
`pagination_token`	Non	String	Jeton de pagination obtenu à partir d’une réponse `/getMessageLog` précédente. Utilisez-le pour récupérer des résultats supplémentaires.
`user_id`	Non	String	Sélectionner les événements de messages par un ID utilisateur personnalisé. Voir `/registerUser` pour plus de détails.
`application_code`	Oui	String	Sélectionner les événements de messages par Code d’application Pushwoosh
`actions`	Non	Array	Filtrer les résultats par actions de message spécifiques. Valeurs possibles : `"sent"`, `"delivered"`, `"opened"`, `"inbox_delivered"`, `"inbox_read"`, `"inbox_opened"`, `"inbox_deleted"`.
`platforms`	Non	Array	Tableau des plateformes cibles pour filtrer les résultats. Valeurs possibles : `"ios"`, `"android"`, `"osx"`, `"windows"`, `"amazon"`, `"safari"`, `"chrome"`, `"firefox"`, `"ie"`, `"email"`, `"huawei_android"`.

Exemple de requête

curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/getMessageLog' \
--header 'Authorization: Key API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "pagination_token": "PAGINATION_TOKEN_FROM_PREVIOUS_RESPONSE",  // optionnel, jeton pour la pagination
   "limit": 1000,                                  // optionnel, le nombre max d'entrées pour une seule réponse
   "application_code": "XXXXX-XXXXX",              // Code d'application Pushwoosh
   "message_code": "A444-AAABBBCC-00112233",       // optionnel, code de message obtenu à partir de la requête /createMessaage
   "message_id": 1234567890,                       // optionnel, ID de message obtenu depuis le panneau de contrôle Pushwoosh
   "campaign_code": "AAAAA-XXXXX",                 // optionnel, code d'une campagne pour obtenir le journal
   "hwid": "aaazzzqqqqxxx",                        // optionnel, ID matériel d'un appareil spécifique ciblé par un message
   "user_id": "user_123",                          // optionnel, ID d'un utilisateur ciblé par le message
   "date_from": "2000-01-25 00:00:00",             // optionnel, début de la période des statistiques
   "date_to": "2000-02-10 23:59:59",               // optionnel, fin de la période des statistiques
   "actions": ["opened", "inbox_opened"],          // optionnel, utilisé pour la filtration des résultats. Valeurs possibles : "sent", "opened", "delivered", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted". La réponse inclura tous les messages avec la ou les actions spécifiées.
   "platforms": ["ios", "chrome"]                  // optionnel, utilisé pour la filtration des résultats. Valeurs possibles : "ios", "android", "osx", "windows", "amazon", "safari", "chrome", "firefox", "ie", "email", "huawei android"
}'

Codes de réponse et exemples

{
  "pagination_token": "PAGINATION_TOKEN_FOR_NEXT_REQUEST",
  "data": [{
    "timestamp": "2000-01-25T11:18:47Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "sent",
    "status": "success",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:18:49Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "delivered",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:19:23Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "opened",
    "push_alerts_enabled": "true"
  }]
}

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

{
  "error": "account not found"
}

Statistiques des e-mails

linksInteractions

Affiche les statistiques sur les clics de liens dans les e-mails

POST https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractions

En-têtes

Nom	Requis	Description
`Authorization`	Oui	Jeton d’accès API depuis le panneau de contrôle Pushwoosh.

Paramètres du corps de la requête

Nom	Requis	Type	Description
`date_range`	Non	Object	Définit la période de rapport. Contient `date_from` et `date_to`.
`filters`	Oui	Object	Filtres d’e-mail.
`application`	Oui	String	Code d’application Pushwoosh (alternativement, spécifiez `campaign`, `messages_ids`, ou `message_codes`).
`messages_codes`	Oui	Array	Codes de message (alternativement, spécifiez `application`, `campaign`, ou `messages_ids`).
`campaign`	Oui	String	Code de campagne (alternativement, spécifiez `application`, `messages_ids`, ou `message_codes`).
`messages_ids`	Oui	Array	ID de message (alternativement, spécifiez `application`, `campaign`, ou `message_codes`).
`link_template`	Requis si `application` ou `campaign` est spécifié.	String	Filtre les interactions de liens d’e-mail par mot-clé. Seuls les liens qui incluent le texte spécifié dans leur URL seront retournés dans la réponse de l’API. Par exemple, si votre e-mail contient des liens comme `https://example.com/news` et `https://example.com/shop`, définir “link_template”: “shop” retournera uniquement les interactions pour `https://example.com/shop`.
`email_content_code`	Non	String	Identifiant unique pour le contenu de l’e-mail.
`params`	Non	Object	Définit des options de réponse supplémentaires. Inclut `with_full_links`, qui ajoute une liste de liens complets avec des statistiques.

Exemple de requête

curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractions' \
--header 'Authorization: Api API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "filters": {
      "date_range": {
         "date_from": "string",           // Format requis : 2000-01-01
         "date_to": "string"              // Format requis : 2000-01-01
      },
      "campaign": "string",               // Code de campagne (vous pouvez spécifier application, messages_ids, ou message_codes à la place)
      "application": "string",            // Code d'application (vous pouvez spécifier campaign, messages_ids, ou message_codes à la place)
      "messages_ids": [],                 // ID de message (vous pouvez spécifier application, campaign, ou message_codes à la place)
      "messages_codes": [],               // Codes de message (vous pouvez spécifier application, campaign, ou message_ids à la place)
      "link_template": "string",          // Modèle de lien (requis si application ou campaign est spécifié)
      "email_content_code": "string"      // Identifiant unique pour le contenu de l'e-mail.
   },
   "params": {
      "with_full_links": true             // Spécifiez s'il faut afficher des statistiques détaillées. Une liste de liens complets avec des statistiques sera passée dans le tableau full_links.
   }
}'

Codes de réponse et exemples

{
  "items": [{
    "template": "string",
    "link": "string",
    "title": "string",
    "clicks": 0,
    "full_links": [{
      "full_link": "string",
      "clicks": 0
    }]
  }]
}

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

{
  "error": "account not found"
}

linksInteractionsDevices

Affiche les utilisateurs qui ont cliqué sur des liens dans les e-mails

POST https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractionsDevices

En-têtes

Nom	Requis	Description
`Authorization`	Oui	Jeton d’accès API depuis le panneau de contrôle Pushwoosh.

Paramètres du corps de la requête

Nom	Requis	Type	Description
`date_range`	Non	Object	Définit la période de rapport. Contient `date_from` et `date_to`.
`filters`	Oui	Object	Filtres d’e-mail.
`application`	Oui	String	Code d’application Pushwoosh (alternativement, spécifiez `campaign`, `messages_ids`, ou `message_codes`).
`messages_codes`	Oui	Array	Codes de message (alternativement, spécifiez `application`, `campaign`, ou `messages_ids`).
`campaign`	Oui	String	Code de campagne (alternativement, spécifiez `application`, `messages_ids`, ou `message_codes`).
`messages_ids`	Oui	Array	ID de message (alternativement, spécifiez `application`, `campaign`, ou `message_codes`).
`link_template`	Requis si `application` ou `campaign` est spécifié.	String	Filtre les interactions de liens d’e-mail par mot-clé. Seuls les liens qui incluent le texte spécifié dans leur URL seront retournés dans la réponse de l’API. Par exemple, si votre e-mail contient des liens comme `https://example.com/news` et `https://example.com/shop`, définir “link_template”: “shop” retournera uniquement les interactions pour `https://example.com/shop`.
`email_content_code`	Non	String	Identifiant unique pour le contenu de l’e-mail.
`page`	Non	Integer	Numéro de page pour la pagination.
`per_page`	Non	Integer	Nombre de résultats par page (≤ 1000).

Exemple de requête

curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractionsDevices' \
--header 'Authorization: Api API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "filters": {
      "date_range": {
         "date_from": "string",         // Format requis : 2000-01-01
         "date_to": "string"            // Format requis : 2000-01-01
      },
      "campaign": "string",             // Code de campagne (vous pouvez spécifier application, messages_ids, ou message_codes à la place)
      "application": "string",          // Code d'application (vous pouvez spécifier campaign, messages_ids, ou message_codes à la place)
      "messages_ids": [],               // ID de message (vous pouvez spécifier application, campaign, ou message_codes à la place)
      "messages_codes": [],             // Codes de message (vous pouvez spécifier application, campaign, ou message_ids à la place)
      "link_template": "string",        // Modèle de lien (requis si application ou campaign est spécifié)
      "email_content_code": "string"    // Identifiant unique pour le contenu de l'e-mail.
   },
   "per_page": 100,
   "page": 0
}'

Codes de réponse et exemples

{
  "total": 0,
  "items": [{
    "timestamp": "string",
    "link": "string",
    "hwid": "string"
  }]
}

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

{
  "error": "account not found"
}

bouncedEmails

POST https://api.pushwoosh.com/api/v2/statistics/emails/bouncedEmails

Fournit des données sur les plaintes par e-mail, les soft bounces et les hard bounces, y compris la date, l’adresse e-mail et la raison de chaque rebond.

Autorisation

L’autorisation est gérée via le jeton d’accès API dans l’en-tête de la requête.

Paramètres du corps de la requête

Nom du paramètre	Type	Description	Requis
`application`	string	Code d’application Pushwoosh	Oui
`message_code`	string	Code de message.	Requis si `date range` ou `campaign` n’est pas fourni
`campaign`	string	Code de campagne.	Requis si `message_code` ou `date range` n’est pas fourni
`date_from`	string	La date de début pour les données au format `AAAA-MM-JJTHH:MM:SS.000Z` (norme ISO 8601).	Requis si `message_code` ou `campaign` n’est pas fourni
`date_to`	string	La date de fin pour les données au format `AAAA-MM-JJTHH:MM:SS.000Z` (norme ISO 8601).	Requis si `message_code` ou `campaign` n’est pas fourni
`per_page`	int	Le nombre de lignes par page, maximum 5000.	Oui
`page`	int	Le numéro de page, à partir de zéro.	Oui
`type`	string	Le type de rebond : Complaint, Softbounce, Hardbounce.	Non

Exemple de requête

{
  "application": "XXXXX-XXXXX",               // requis. Code d'application Pushwoosh
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // requis si la campagne ou la plage de dates n'est pas fournie.
                                              //          Identifiant unique du message
  "campaign": "XXXXX-XXXXX",                  // requis si le code de message ou la plage de dates n'est pas fourni.
                                              //          Code de campagne
  "date_from": "2024-07-20T00:00:00.000Z",    // requis si le code de message ou la campagne n'est pas fourni.
                                              //          Date de début au format ISO 8601 "AAAA-MM-JJTHH:MM:SS.SSSZ"
  "date_to": "2024-07-20T00:00:00.000Z",      // requis si le code de message ou la campagne n'est pas fourni.
                                              //          Date de fin au format ISO 8601 "AAAA-MM-JJTHH:MM:SS.SSSZ"
  "per_page": 1000,                           // requis. Nombre de résultats par page, maximum 5000
  "page": 5,                                  // optionnel. Numéro de page, à partir de zéro
  "type": "Softbounce"                        // optionnel. Le type de rebond : Complaint, Softbounce, Hardbounce
}

Champs de la réponse

Nom du champ	Type	Description
`total`	int	Le nombre total de lignes.
`bounced_emails`	array	Un tableau de détails des e-mails retournés.
├── `email`	string	L’adresse e-mail qui a été retournée.
├── `date`	string	La date du rebond (format : `AAAA-MM-JJTHH:MM:SS.000Z`).
├── `reason`	string	La raison du rebond.
└── `type`	string	Le type de rebond : Complaint, Softbounce, Hardbounce.

Exemple de réponse

{
  "total": 25,                             // Nombre total de lignes.
  "bounced_emails": [{
    "email": "example@example.com",        // Adresse e-mail qui a été retournée
    "date": "2024-07-20T00:00:00.000Z",    // Date du rebond au format ISO 8601
    "reason": "Invalid recipient address", // Raison du rebond
    "type": "Hardbounce"                   // Type de rebond : Complaint, Softbounce, Hardbounce
  }]
}