API: HTTP Report Daily Statistics

The Report Daily Statistics command allows you to return a list of daily totals in a date range for a specific campaign.

Arguments

The Report Daily Statistics command requires the following arguments: Command, Realm, Password, Campaign ID, From Date, and To Date.

api_web?r=myrealm&p=mypass&c=rpt_daily_stats&campaign_id=11&from_date=06/01/2012&to_date=06/20/2012

The command is ‘rpt_daily_stats’, the realm is ‘myrealm’ and the password is ‘mypass’. The command will return the following details for each day in the range for the campaign with id='11':

Date	Date campaign deployed
Campaign ID	Campaign Identifier
Total Sent	Number of contacts sent a message
Total Opened	Number of tracked open events
Unique Opened	Number of unique contacts who opened a message
Total Click-Throughs	Number of tracked click-through events
Unique Click-Throughs	Number of unique contacts who clicked a link in the message
Total Soft Bounces	Number of messages that soft bounced
Total Hard Bounces	Number of messages that hard bounced
Total Unsubscribed	Number of list level optouts only
Total Complaint Bounces	Number of feedback loop abuse complaints received. Only displayed if &version=7.3.0 or newer version included in command.
Total Blocked Bounces	Number of reports that messages are blocked. Only displayed if &version=7.3.0 or newer version included in command.

The Report Daily Statistics command supports the following arguments:

Name	Req?	Description	Argument
Command	Yes	Defines the command to use.	cmd=rpt_daily_stats c=rpt_daily_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]
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]
Version		Version of API to use. Data may be added to newer versions of the API. To alleviate issues for users who have already coded file parsing, new columns are only displayed if the version is included.	version=[version_number] 7.3.0 = complaint and block bounce totals
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_daily_stats&r=myrealm&p=mypass&campaign_id=11&from_date=06/01/2012&to_date=06/20/2012&version=7.3.0&output_format=csv&headers=1

Successful results return:

"Date","Campaign_ID","Total_sent","Total_opened","Unique_opened", "Total_clickthroughs","Unique_clickthroughs","Total_soft_bounced", "Total_hard_bounced","Total_unsubscribed","Total_complaints_bounced", "Total_blocked_bounced"
"06/20/2012","11","27","10","4","0","0","0","0","0","0","0"
"06/21/2012","11","0","1","1","0","0","0","0","0","0","0"

Results

The Report Daily Statistics command outputs either the results of the search or a FAILURE message.

SUCCESS

The Report Daily 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 Daily Statistics command will fail for several reasons, such as if the campaign doesn't exist. The result format is:

FAILURE: [Reason]