API: HTTP Choose A/B Winner
The Choose A/B Winner command allows you to select which A/B Sample to send to the rest of the A/B campaign recipients.
Arguments
Choose A/B Winner requires the following arguments: Command, Realm, Password, and Sample Encrypted ID.
api_web?r=myrealm&p=mypass&c=abmailwinner&encrypted_id=46462B07BFFF8B1C8F47FD663EB49F5C
The command is ‘abmailwinner’, the realm is ‘myrealm’ and the password is ‘mypass’. The winning sample's encrypted ID is '46462B07BFFF8B1C8F47FD663EB49F5C'.
Use Report A/B Test Statistics to find the encrypted_id of the winning sample.
The Choose A/B Winner command supports the following arguments:
Name | Req? | Description | Argument |
Command | Yes | Defines the command to use. | cmd=abmailwinner c=abmailwinner |
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] |
Sample Encrypted ID |
| The HEX encrypted identifier of the Sample to send to the remainder of the recipients. | encrypted_id=[encrypted_id] |
Example
Using all commands and arguments (please note the command is wrapped for display purposes only):
api_web?r=myrealm&p=mypass&c=abmailwinner&encrypted_id=46462B07BFFF8B1C8F47FD663EB49F5C
Successful results return:
SUCCESS
Results
The Choose A/B Winner command outputs either a SUCCESS or a FAILURE message.
SUCCESS
The Choose A/B Winner command returns a simple SUCCESS message;
SUCCESS
FAILURE
A Choose A/B Winner command will fail for several reasons. The result format is:
FAILURE: [Reason]