Aller au contenu principal

Obtenir les statistiques d'envoi d'une communication

GET

https://api-v2.test.eldowallet.fr/communications/:id/stats

Statistiques de remise de la notification push d'une communication, par porteur de carte de fidélité active (avec son e-mail et son téléphone), paginées, avec un résumé du taux de réussite global et par plateforme (iOS, Android). Le résumé indique aussi le statut de la communication et sa prochaine échéance (début ou fin).

À retenir
  • Les destinataires sont les cartes de fidélité actives actuelles du wallet, et non une liste figée au moment de l'envoi. Un destinataire sans trace de remise est PENDING.

Requête​

path parameters
  • id string required
    Identifiant de la communication (ObjectId de 24 caractères hexadécimaux).
query parameters
  • limit number
    Nombre de destinataires par page, de 1 à 1 000. Par défaut : `10`.
    default: 10min: 1max: 1000
  • page number
    Numéro de page, à partir de 1. Par défaut : `1`.
    default: 1min: 1
header parameters
  • x-lang string
    Langue des messages d'erreur et des textes renvoyés : `fr` ou `en`.
    enum: en, frdefault: "en"

Réponses​

Schéma application/json
  • docs object[] required
  • summary object
    • communicationStatus string requiredenum: PENDING, ACTIVE, INACTIF, EXPIRED
    • statusUpdatedAt string <date-time> required
      Date de la dernière mise à jour de `communicationStatus`.
    • nextMilestoneType string
      `START` tant que le statut est `PENDING` (en attente de `startDate`), `EXPIRY` tant qu'il est `ACTIVE` (en attente de `endDate`), `null` sinon.
      enum: START, EXPIRY
    • nextMilestoneDate object
    • totalRecipients number required
      Nombre de destinataires distincts ciblés par notification push pour cette communication.
    • successCount number required
      Destinataires atteints sur au moins un appareil.
    • failedCount number required
      Destinataires qui n'ont été atteints sur aucun appareil.
    • pendingCount number required
      Destinataires pas encore traités.
    • globalSuccessRate number required
    • androidTotal number required
    • androidSuccessRate number required
    • iosTotal number required
    • iosSuccessRate number required
  • totalDocs number required
  • limit number required
  • page number
  • totalPages number required
  • pagingCounter number required
  • hasPrevPage boolean required
  • hasNextPage boolean required
  • prevPage number
  • nextPage number

Les nouveautés de l'API, une fois par mois

Nouveaux endpoints, changements à prévoir, guides et cas d'usage. Pas de spam, désinscription en un clic.

Signaler un problème technique

Une erreur de l’API, un pass qui ne se met pas à jour, un e-mail qui n’arrive pas ? Décrivez le problème : notre équipe technique vous répond.

Pour une réponse rapide, indiquez :

  • La méthode et l’endpoint (ex. POST /clients)
  • Le code d’erreur renvoyé (errorCode) et le corps envoyé
  • La date et l’heure de l’appel
  • Les identifiants concernés (client, modèle, pass)

N’y mettez jamais de jeton d’API ni de mot de passe.

Assistant IA

Beta

Chargement…

Réponses générées par IA (Claude) : vérifiez les points importants.

Connectez-vous pour utiliser l'assistant