Skip to main content

CommunicationDeliveryStatsSummaryDto

communicationStatusstringrequired

Possible values: [PENDING, ACTIVE, INACTIF, EXPIRED]

statusUpdatedAtstring<date-time>required

When communicationStatus was last updated

nextMilestoneTypestringnullable

START while PENDING (awaiting startDate), EXPIRY while ACTIVE (awaiting endDate), null otherwise

Possible values: [START, EXPIRY]

nextMilestoneDateobjectnullable
totalRecipientsnumberrequired

Distinct recipients targeted by push for this communication

successCountnumberrequired

Recipients reached on at least one device

failedCountnumberrequired

Recipients not reached on any device

pendingCountnumberrequired

Recipients not dispatched yet

globalSuccessRatenumberrequired
androidTotalnumberrequired
androidSuccessRatenumberrequired
iosTotalnumberrequired
iosSuccessRatenumberrequired
CommunicationDeliveryStatsSummaryDto
{
"communicationStatus": "PENDING",
"statusUpdatedAt": "2024-07-29T15:51:28.071Z",
"nextMilestoneType": "START",
"nextMilestoneDate": {},
"totalRecipients": 0,
"successCount": 0,
"failedCount": 0,
"pendingCount": 0,
"globalSuccessRate": 0,
"androidTotal": 0,
"androidSuccessRate": 0,
"iosTotal": 0,
"iosSuccessRate": 0
}

API news, once a month

New endpoints, upcoming changes, guides and use cases. No spam, one-click unsubscribe.

Report a technical problem

An API error, a pass that does not update, an email that does not arrive? Describe the problem: our technical team will answer.

For a fast answer, include:

  • The method and endpoint (e.g. POST /clients)
  • The error code returned (errorCode) and the body sent
  • The date and time of the call
  • The identifiers involved (customer, template, pass)

Never include an API token or a password.

AI assistant

Beta

Loading…

AI-generated answers (Claude): double-check important details.

Sign in to use the assistant