Get communication delivery statistics

GET

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

Delivery statistics for a communication's push notification, per holder of an active loyalty card (with their email and phone number), paginated, with an overall and per-platform (iOS, Android) success summary. The summary also gives the communication's status and its next milestone (start or end).

Good to know

• Recipients are the wallet's current active loyalty cards, not a snapshot taken at send time. A recipient with no delivery record yet is PENDING.

Request

path parameters

• id string required
  Communication ID (24-character hexadecimal ObjectId).

query parameters

• limit number
  Recipients per page, from 1 to 1,000. Default: `10`.
  default: 10min: 1max: 1000
• page number
  Page number, starting at 1. Default: `1`.
  default: 1min: 1

header parameters

• x-lang string
  Language for responses
  enum: en, frdefault: "en"

Responses

200

Schema application/json

• docs object[] required
• summary object
  • communicationStatus string requiredenum: PENDING, ACTIVE, INACTIF, EXPIRED
  • statusUpdatedAt string <date-time> required
    When communicationStatus was last updated
  • nextMilestoneType string
    START while PENDING (awaiting startDate), EXPIRY while ACTIVE (awaiting endDate), null otherwise
    enum: START, EXPIRY
  • nextMilestoneDate object
  • totalRecipients number required
    Distinct recipients targeted by push for this communication
  • successCount number required
    Recipients reached on at least one device
  • failedCount number required
    Recipients not reached on any device
  • pendingCount number required
    Recipients not dispatched yet
  • 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

401

UNAUTHORIZED

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

403

FORBIDDEN

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

404

MODEL_NOT_FOUND

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

500

UNKNOWN_ERROR

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email