The Report Browser Info command allows you to return browser, operating system, and client type for opens or click-throughs tracked in a specific campaign.
Arguments
The Report Browser Info command requires the following arguments: Command, Realm, Password, and Campaign ID.
api_web?r=myrealm&p=mypass&c=rpt_browser_info&campaign_id=11
The command is ‘rpt_browser_info’, the realm is ‘myrealm’ and the password is ‘mypass’. The command will return the following details for the campaign with id='11': campaign_id, os_name, browser, client_type.
Data columns available to report include:
|
Campaign ID (campaign_id) |
Campaign Identifier, default |
|
Operating System (os_name) |
Name of the operating system from which the event was tracked, default |
|
Browser (browser) |
Name of the browser from which the event was tracked, default |
|
Client Type (client_type) |
Type of client from which the event was tracked, default |
|
Customer Key (customer_key) |
Identifier for the subscriber in realm with Customer Key enabled |
|
Subscriber ID (subscriber_id) |
Identifier for the subscriber |
|
Email (email) |
Subscriber email address |
|
First Name (first_name) |
Subscriber first name |
|
Last Name (last_name) |
Subscriber last name |
|
Event Date (event_date) |
Date the event was tracked |
|
Event Type (event_type) |
Type of event, Read (Open) or Clicked (Click-Through) |
The Report Browser Info command supports the following arguments:
|
Name |
Req? |
Description |
Argument |
|
Command |
Yes |
Defines the command to use. |
cmd=rpt_browser_info c=rpt_browser_info |
|
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] |
| Subscriber Info | Option to include the subscriber specific details for each item including: subscriber_id, email, first_name, last_name |
by_subscriber=[0,1] DEFAULT==0 |
|
| Operating System | The specific operating system to report, including but not limited to the options listed. | os_name=[windows,mac%20osx, ios,android,blackberryos, linux,mac%20os,unknown] | |
| Browser | The specific browser to report, including but not limited to the options listed. |
browser=[firefox,chrome, safari,internet%20explorer, opera,apple%20mail,camino, cfnetwork,eudora,evolution, flock,lynx,mozilla,outlook, pocomail,seamonkey, thunderbird,unknown] |
|
| Client Type | The specific client type to report, including but not limited to the options listed. | client_type=[computer,mobile,ipad, iphone,tablet,digital, game%20console,unknown] | |
|
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] 10.7.0 = include event_date and event_type |
|
|
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_browser_info&r=myrealm&p=mypass&campaign_id=11&by_subscriber=1&os_name=android&browser=safari&client_type=mobile&output_format=csv&headers=1&version=10.7.0
Successful results return:
"campaign_id","subscriber_id","email","first_name","last_name","os_name","browser","client_type","event_date","event_type" "11","1202","jane@domain.com","Jane","Doe","ANDROID","SAFARI","MOBILE","2015-02-16 18:11:55","CLICKED"
Some systems have the ability to define a unique Customer Key per subscriber. If your realm has Customer Key enabled, and additional column "customer_key" will be included in the results.
Results
The Report Bounce Info command outputs either the results of the search or a FAILURE message.
SUCCESS
The Report Bounce Info 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 Info command will fail for several reasons, such as if the campaign doesn't exist. The result format is:
FAILURE: [Reason]
Comments