Get bounces
Post /statistics/bounces
Introduction
Get all datas provided by your sent aggregated per day
Parameters:
Name | Description | Type | Mandatory |
---|---|---|---|
dateBegin | Date begin on YYYY-MM-ddThh:mm:ss format | Int | No |
dateEnd | Date end on YYYY-MM-ddThh:mm:ss format | Int | No |
froms | Array of Senders email | Array | No |
apiKeys | Array of api keys | Array | No |
tags | Array of tags | Array | No |
Response:
Name | Description | Type | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
date |
An array with information about each bounce return on date
|
String |
Programming language:
Request exemple:
{ "dateBegin": 1454545657, "dateEnd": 1564564564 }
Response exemple:
{ "1438387200": { "requested": 7689, "hardbounced": 36, "softbounced": 3479 }, "1441065600": { "requested": 58, "hardbounced": 1, "softbounced": 19 }, "1443657600": { "requested": 196, "hardbounced": 7, "softbounced": 10 } }
Code example:
curl -X POST -d '{"dateBegin":"1443046641","dateEnd":"1443219441"}' -H "Content-Type: application/json" -H "X-Tipimail-ApiUser:YOUR_API_USERNAME" -H "X-Tipimail-ApiKey:YOUR_API_KEY" https://api.tipimail.com/v1/statistics/bounces
require 'vendor/autoload.php'; $tipimail = new Tipimail\Tipimail('YOUR_SMTP_USERNAME', 'YOUR_API_KEY'); try { $dateBegin = null; $dateEnd = null; $froms = null; $apiKeys = null; $tags = null; $result = $tipimail->getStatisticsService()->getBouncesByDate($dateBegin, $dateEnd, $froms, $tags, $apiKeys); var_dump($result); } catch(Tipimail\Exceptions\TipimailException $e) { echo 'Exception received :', $e->getMessage(), "\n"; }
... public class Example { public static void main(String[] args) { Tipimail tipimail = new Tipimail("YOUR_SMTP_USERNAME", "YOUR_API_KEY"); try { nteger dateBegin = null; Integer dateEnd = null; ArrayList<String> froms = null; ArrayList<String> tags = null; ArrayList<String> apiKeys = null; HashMap<String, StatisticsBounces> bouncesByDate; bouncesByDate = tipimail.getStatisticsService().getBouncesByDate(dateBegin, dateEnd, froms, tags, apiKeys); } catch (TipimailException e) { } } }