Get bounces list

Using this method you can retrieve a CSV with a list of bounces for a particular time period.

The list includes bounce date, bounced email address, and diagnostic codes.


Request data format

Request URL parameters:

Examples:

https://api.esv2.com/v2/Api/Bounces?apiKey=YOUR_API_KEY_HERE&startDate=2010-05-20&endDate=2010-05-22

https://api.esv2.com/v2/Api/Bounces?apiKey=YOUR_API_KEY_HERE&startDate=2010-05-20&endDate=2010-05-22&bounceReason=1

https://api.esv2.com/v2/Api/Bounces?apiKey=YOUR_API_KEY_HERE&startDate=2010-05-20&endDate=2010-05-22&bounceType=2



Response

The response from this method is always data in CSV format, rather than XML, because the amount of data returned can be substantial. 

CSV response minimizes overheads and allows for seamless integration with third party code/systems. 

Response content type is "text/csv". Returned data contains a header with column names in the first row.


CSV output is formatted using following settings:


CSV response columns: 

CSV response for channel set to:

* In each row either Email or Phone should be filled in, never both.


Bounce reasons (one of those will be in BounceReason column in CSV):

Bounce type (one of those will be in BounceReason column in CSV):

Examples

Get multiple messages

Request:

GET https://api.esv2.com/v2/Api/Bounces?apiKey=test_api_key1&startDate=2010-10-01&endDate=2010-10-02&channel=Email HTTP/1.1 

Accept-Encoding: gzip,deflate 

User-Agent: Jakarta Commons-HttpClient/3.1 

Host: api.esv2.com


OK response:

HTTP/1.1 200 OK 

Cache-Control: private 

Content-Type: text/csv; charset=utf-8 

Server: Microsoft-IIS/7.5 

X-AspNetMvc-Version: 2.0 

X-AspNet-Version: 2.0.50727 

Set-Cookie: TIMEZONE=Central European Standard Time; path=/ 

X-Powered-By: ASP.NET 

Date: Thu, 08 Dec 2011 12:02:14 GMT 

Content-Length: 463  

 

Date,Email,BounceCode,BounceReason, BounceType

2010-10-01 17:10:00,test1@yahoo.com,some test bounce code,UserUnknown, Hard 

2010-10-01 17:10:00,test2@yahoo.com,some test bounce code,MailboxFull, Soft 

2010-10-01 17:11:00,test3@yahoo.com,some test bounce code,Blocked, Soft

2010-10-01 17:12:00,test4@yahoo.com,some test bounce code,Unknown, Soft

2010-10-01 19:20:00,john.doe@gmail.com,some test bounce code,Other, Hard