API: HTTP Report A/B Test Statistics
Arguments
The Report A/B Test Statistics requires the following arguments: Command, Realm, Password, and A/B Definition ID.
api_web?r=myrealm&p=mypass&c=rpt_abstats&ab_definition_id=123
The command is ‘rpt_abstats’, the realm is ‘myrealm’ and the password is ‘mypass’. The results for the test run with definition '123' will be displayed.
The Report A/B Test Statistics command supports the following arguments:
|
Name |
Req? |
Description |
Argument |
|
Command |
Yes |
Defines the command to use. |
cmd=rpt_abstats c=rpt_abstats |
|
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] |
| A/B Definition ID | Yes | ID of the definition statistics to return. | ab_defintion_id=[ab_definition_id] |
|
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] |
|
Headers |
|
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?r=myrealm&p=mypass&c=rpt_abstats&ab_definition_id=123&output_format=csv&headers=1
Successful results return the following sample results for a two sample A/B Test:
A,9AC22FAFF37248F696782414C983F5B6,131,561,1364,1043,mytemplatd,sampleA,samplea@domain.com,3692,0,0,0.0,0.0,...,0,0,0,0,0,0,0 B,0B06343FC9C6FD40C04E2B7E69CA9C20,131,561,1365,1043,mytemplate,sampleB,sampleb@domain.com,3693,1,0,0.0,0.0,...,0,0,0,0,0,0,0
Results
The Report A/B Test Statistics command outputs either the results of the search or a FAILURE message.
SUCCESS
The Report A/B Test Statistics command does not explicitly return a Success code. Instead, it outputs the following details:
sample,encrypted_id,ab_definition_id,ab_result_id,ab_result_sample_id,template_id,template_name,subject,from_address,campaign_id,is_winner,is_deployed,unique_open_rate,unique_click_rate,total_sent,total_delivered,unique_hard_bounce,unique_soft_bounce,unique_blocked,total_complaints,total_responders,total_unsubscribes,unique_complaints,click_to_open_rate,open_rate,responder_rate,unsubscribe_rate,click_rate,complaint_rate,hard_bounce_rate,soft_bounce_rate,blocked_rate,delivered_rate,fb_posts,fb_displays,fb_unique_posts,fb_unique_displays,tw_posts,tw_displays,tw_unique_posts,tw_unique_displays,ln_posts,ln_displays,ln_unique_posts,ln_unique_displays,dg_posts,dg_displays,dg_unique_posts,dg_unique_displays,msp_posts,msp_displays,msp_unique_posts,msp_unique_displays,total_hard_bounce,total_soft_bounce,total_blocked **DEPRECATED** v17.00.00,social_shares,social_views,social_clicks
FAILURE
A Report A/B Test Statistics command will fail for several reasons. The result format is:
FAILURE: [Reason]