Get Push delivery reports
If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.
Authorizations:
Request rate limit:
query Parameters
bulkId | string The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address. |
messageId | string The ID that uniquely identifies the message sent. |
limit | integer <int32> <= 1000 Default: 50 Example: limit=1 Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h |
entityId | string Example: entityId=promotional-traffic-entity Entity id used to send the message. For more details, see our documentation. |
applicationId | string Example: applicationId=marketing-automation-application Application id used to send the message. For more details, see our documentation. |
campaignReferenceId | string Example: campaignReferenceId=summersale ID of a campaign that was sent in the message. |
Responses
OK
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
Request samples
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
curl -L -g 'https://{baseUrl}/push/3/reports?limit=1&entityId=promotional-traffic-entity&applicationId=marketing-automation-application&campaignReferenceId=summersale' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json'
Response samples
- 200
- 401
- 403
- 429
- 500
{- "results": [
- {
- "bulkId": "string",
- "price": {
- "pricePerMessage": 0,
- "currency": "string"
}, - "status": {
- "groupId": 0,
- "groupName": "ACCEPTED",
- "id": 0,
- "name": "string",
- "description": "string",
- "action": "string"
}, - "error": {
- "groupId": 0,
- "groupName": "OK",
- "id": 0,
- "name": "string",
- "description": "string",
- "permanent": true
}, - "messageId": "string",
- "to": "string",
- "sender": "string",
- "sentAt": "2025-03-15T15:00:13Z",
- "doneAt": "2025-03-15T15:00:13Z",
- "messageCount": 0,
- "mccMnc": "string",
- "callbackData": "string",
- "platform": {
- "entityId": "string",
- "applicationId": "string"
}, - "campaignReferenceId": "string"
}
]
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See