Push Notifications
Get Delivery Status
Read the per-recipient delivery outcome for a notification.
GET
Get Delivery Status
Returns one entry per recipient the notification was actually sent to, with
the real outcome APNs/FCM reported — not just the notification’s overall
status. Useful for seeing exactly which devices received it and why any
individual delivery failed.
An empty array means nothing has been attempted yet — for example, the
notification is still
See the API introduction to set up your base URL and private key before making requests.
Parameters
string
required
The
notificationId returned when the notification was sent.string
Deprecated alternative to the
lerix-key header, still accepted.Response
200 OK
string
ios, android, web, macos or windows. A device registered from a
platform Lerix can’t deliver to yet (for example Linux) keeps its own value here.string
sent or failed, the real outcome APNs/FCM reported for this recipient.string | null
The failure reason when
status is failed; null otherwise. This is
either the provider’s own reason, or one of these Lerix codes in brackets
followed by a message:Windows deliveries can also report the WNS codes listed in Windows troubleshooting.Example:
[PLATFORM_NOT_CONFIGURED] Apple keys not configured.string | null
The device token this delivery targeted.
null if the token was
automatically removed after being reported permanently invalid — the
delivery record is kept even after its token is gone.scheduled, or was canceled before it was due.
On failure, the response follows the shape documented in Error & success codes.