Arguments
The Report Campaign Clicks command requires the following arguments: Command, Realm, Password, and Campaign ID.
api_web?r=myrealm&p=mypass&c=rpt_click_overview&campaign_id=12
The command is ‘rpt_click_overview’, the realm is ‘myrealm’ and the password is ‘mypass’. The command will return a list of all URLs in the campaign and the number of total and unique click-through events for each.
The Report Campaign Clicks command supports the following arguments:
|
Name |
Req? |
Description |
Argument |
|
Command |
Yes |
Defines the command to use. |
cmd=rpt_click_overview c=rpt_click_overview |
|
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 to report. |
campaign_id=[campaign_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] |
|
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_click_overview&r=myrealm&p=mypass&campaign_id=12
Successful results return:
"url","total_clicks","unique_clicks"
"http://www.ask.com","4","2"
"http://www.google.com","3","2"
"http://www.yahoo.com","1","1"
Results
The Report Campaign Clicks command outputs either the results of the search or a FAILURE message.
SUCCESS
The Report Campaign Clicks command does not explicitly return a Success code. Instead, it outputs the campaign details in plain text format. Use the output_format argument to return the results in an alternate format.
FAILURE
A Report Campaign Clicks command will fail for several reasons. The result format is:
FAILURE: [Reason]