API: HTTP Report Bounce Statistics
The Report Bounce Statistics command allows you to return a list of contacts with a specific bounce event type in a date range for a single campaign.
Arguments
The Report Bounce Statistics command requires the following arguments: Command, Realm, Password, Campaign ID, Bounce Type, From Date, and To Date.
api_web?r=myrealm&p=mypass&c=rpt_bounce_stats&campaign_id=11&bounce_type=30&from_date=06/01/2012&to_date=06/20/2012
The command is ‘rpt_bounce_stats’, the realm is ‘myrealm’ and the password is ‘mypass’. The command will return the contact email address, campaign ID, event date, bounce type and category for all soft bounces in the campaign.
The Report Bounce Statistics command supports the following arguments:
|
Name |
Req? |
Description |
Argument |
|
Command |
Yes |
Defines the command to use. |
cmd=rpt_bounce_stats c=rpt_bounce_stats |
|
Realm |
Yes |
Name of the realm to run the command. This is required, and the command will fail if the realm and password do not match. |
realm=[realm_name] r=[realm_name] |
|
Password |
Yes |
Authentication code for API access. This is required, and the command will fail if the realm and password do not match. |
pwd=[password] p=[password] |
|
Campaign ID |
Yes |
Identifier for the campaign data to return. |
campaign_id=[campaign_id] |
| Bounce Type | Yes |
Identifier for the type of bounce event to report. Soft Bounce = 30 Hard Bounce = 31 Complaint = 34 Block Bounce = 36 |
bounce_type=[30,31,34,36] |
| Start Date | Yes | Date to start reporting statistics | from_date=[mm/dd/yyyy] |
| End Date | Yes | Date to end reporting statistics | to_date=[mm/dd/yyyy] |
|
Output Format |
|
To specify the format of the list output, use one of two arguments. If no argument is included, the default output is space-delimited plain text string, which may not include all data columns. |
csv=1 or output_format=[csv,csv_tab, csv_pipe,xml] |
|
Header |
| To define the data with a label, use the Header argument. This can only be used in conjunction with the output format, and does not affect XML. |
headers=[0,1] DEFAULT==0 |
Example
Using all commands and arguments (please note the command is wrapped for display purposes only):
api_web?c=rpt_bounce_stats&r=myrealm&p=mypass&campaign_id=11&bounce_type=31&from_date=06/01/2012&to_date=06/20/2012&output_format=csv&headers=1
Successful results return:
"Campaign_ID","Date","Type Category","Email"
"11","6/20/2012","Hard Mailbox Unknw","joe@myemail.com"
"11","6/20/2012","Hard Domain Invalid","jack@myemail.com"
"11","6/20/2012","Hard Mailbox Inactive","jane@myemail.com"
Some systems have the ability to define a unique Customer Key per contact. If your realm has Customer Key enabled, and additional column "customer_key" will be included in the results.
Results
The Report Bounce Statistics command outputs either the results of the search or a FAILURE message.
SUCCESS
The Report Bounce Statistics command does not explicitly return a Success code. Instead, it outputs the campaign id, list name, subject, date sent, and number of recipients in plain text format. Use the output_format argument to return the results in an alternate format.
FAILURE
A Report Bounce Statistics command will fail for several reasons, such as if the campaign doesn't exist. The result format is:
FAILURE: [Reason]