Method: GET
Endpoint: /api/getBroadcastStatsBounced/{schedule_id}
Parameters
Parameter |
Type |
Required |
Description |
schedule_id |
int |
Yes |
Schedule id of schedule to get bounced stats |
limit_start |
int (default: 0) |
No |
Starting row of result. Default: 0 |
limit_count |
int (default: 0) |
No |
Number of records to get. Default: 25 |
Response Parameters
Parameter |
Type |
Description |
status |
JSON |
Success or Error |
result |
JSON |
Result of the operation |
response |
JSON |
Output of the operation |
Example Request (CURL)
<?php
// Authentication
$api_token = 'API_KEY'; // Mumara API Key (can be found in Settings -> API Key)
$domain = 'http://www.anydomain.com'; // Your Mumara Domain Name
// API Endpoint
$endpoint = '/api/getBroadcastStatsBounced/';
//parameters
$data = array (
'limit_start' => '1',
'limit_count' => '2',
'api_token' => $api_token
);
//Schedule id
$schedule_id = 31;
$params = '';
foreach($data as $key=>$value)
$params .= $key.'='.$value.'&';
$params = trim($params, '&');
// Defining cURL Request
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,$domain.$endpoint.$schedule_id.'?'.$params);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
// Executing cURL
$output = curl_exec ($ch);
// Printing Output
echo "<pre>";
print_r(json_decode($output,true));
// Closing cURL
curl_close ($ch);
?>
Example Response (JSON)
{
"status": "success",
"result": [
{
"id": 5,
"created_at": "2020-07-19 11:37:20",
"email": "[email protected]",
"type": "hard",
"code": " (344)",
"reason": "421 4.7.0 [TSS04] Messages from 50.31.49.42 temporarily deferred due to user complaints - 4.16.55.1; see https://help.yahoo.com/kb/postmaster/SLN3434.html",
"smtp_id": 25,
"message_id": "<[email protected]>",
"smtp": "sendgrid",
"subscribers_id": 72
},
{
"id": 6,
"created_at": "2020-07-19 13:23:02",
"email": "[email protected]",
"type": "hard",
"code": " (344)",
"reason": "421 4.7.0 [TSS04] Messages from 167.89.12.138 temporarily deferred due to user complaints - 4.16.55.1; see https://help.yahoo.com/kb/postmaster/SLN3434.html",
"smtp_id": 25,
"message_id": "<[email protected]>",
"smtp": "sendgrid",
"subscribers_id": 72
}
]
}
Status value of the success response will be "Success".
Example Error Response (JSON)
{
"status": "error",
"result": "Error: Bounce stats do not exist."
}
Possible Errors
- Bounce stats do not exist.
- Access Denied