Developers

Example Usage of
campaign_report_link_list

View all links (and click data) for a specific campaign.

Description: View all links (and click data) for a specific campaign. You will be able to see each individual link, and which contacts clicked on each, much like on the Campaign Reports page.
Endpoint: /admin/api.php?api_action=campaign_report_link_list
HTTP method: GET
Supported output formats: xml, json, serialize
Requires authentication: true
Parameters:
* indicates requirement. Underlined params include in URL, otherwise as part of the post body. POST data must be formatted as
Content-Type: application/x-www-form-urlencoded
. We don't accept any other input formats like JSON.
Variable Description
api_action*campaign_report_link_list
api_key*Your API key
api_outputxml, json, or serialize (default is XML)
campaignid*ID of the campaign you wish to see bounces for
messageid*Message ID
Example response:
Variable Description
0Array
idID of the link row in the database. Example: 71
nameShort name of the link, often found in the title attribute. Example: Web Copy Link
linkActual URL. Example: http://mysite.com/em/p_v.php
a_uniqueNumber of unique clicks on this link. Example: 1
a_totalTotal number of clicks on this link. Example: 1
infoArray
0Array
emailtest@gmail.com
subscriberid2
tstamp2011-03-07 11:52:16
times1
1Array
id72
nameSocial: Facebook
linkhttp://mysite.com/em/index.php?action=social&c=cmpgnhash.currentmesg&ref=facebook
a_unique1
a_total1
infoArray
0Array
emailtest@gmail.com
subscriberid2
tstamp2011-03-07 11:52:30
times1
2Array
id73
nameSocial: Twitter
linkhttp://mysite.com/em/index.php?action=social&c=cmpgnhash.currentmesg&ref=twitter
a_unique1
a_total1
infoArray
0Array
emailtest@gmail.com
subscriberid2
tstamp2011-03-07 11:52:26
times1
3Array
id74
nameSocial: Digg
linkhttp://mysite.com/em/index.php?action=social&c=cmpgnhash.currentmesg&ref=digg
a_unique0
a_total0
infoArray
4Array
id75
nameSocial: del.icio.us
linkhttp://mysite.com/em/index.php?action=social&c=cmpgnhash.currentmesg&ref=delicious
a_unique0
a_total0
infoArray
5Array
id76
nameSocial: buzz
linkhttp://mysite.com/em/index.php?action=social&c=cmpgnhash.currentmesg&ref=greader
a_unique0
a_total0
infoArray
6Array
id77
nameSocial: Reddit
linkhttp://mysite.com/em/index.php?action=social&c=cmpgnhash.currentmesg&ref=reddit
a_unique0
a_total0
infoArray
7Array
id78
nameSocial: StumbleUpon
linkhttp://mysite.com/em/index.php?action=social&c=cmpgnhash.currentmesg&referral=stumbleupon
a_unique0
a_total0
infoArray
8Array
id79
nameForward to a Friend Link
linkhttp://mysite.com/em/p_f.php
a_unique1
a_total1
infoArray
0Array
emailtest@gmail.com
subscriberid2
tstamp2011-03-07 11:42:24
times1
result_codeWhether or not the response was successful. Examples: 1 = yes, 0 = no
result_messageA custom message that appears explaining what happened. Example: Something is returned
result_outputThe result output used. Example: serialize

PHP Example

This is an example of using the campaign_report_link_list call with PHP. You can replicate the same idea in virtually any other programming language. The example shown is using serialize as the output format. You can change that to XML or JSON if you would like.

<?php

// By default, this sample code is designed to get the result from your ActiveCampaign installation and print out the result
$url = 'http://account.api-us1.com';


$params = array(

	// the API Key can be found on the "Your Settings" page under the "API" tab.
	// replace this with your API Key
	'api_key'      => 'YOUR_API_KEY',

	// this is the action that fetches a list info based on the ID you provide
	'api_action'   => 'campaign_report_link_list',

	// define the type of output you wish to get back
	// possible values:
	// - 'xml'  :      you have to write your own XML parser
	// - 'json' :      data is returned in JSON format and can be decoded with
	//                 json_decode() function (included in PHP since 5.2.0)
	// - 'serialize' : data is returned in a serialized format and can be decoded with
	//                 a native unserialize() function
	'api_output'   => 'serialize',

	// ID you wish to fetch
	'campaignid'          => '137',
	'messageid'           => '4',
);

// This section takes the input fields and converts them to the proper format
$query = "";
foreach( $params as $key => $value ) $query .= urlencode($key) . '=' . urlencode($value) . '&';
$query = rtrim($query, '& ');

// clean up the url
$url = rtrim($url, '/ ');

// This sample code uses the CURL library for php to establish a connection,
// submit your request, and show (print out) the response.
if ( !function_exists('curl_init') ) die('CURL not supported. (introduced in PHP 4.0.2)');

// If JSON is used, check if json_decode is present (PHP 5.2.0+)
if ( $params['api_output'] == 'json' && !function_exists('json_decode') ) {
	die('JSON not supported. (introduced in PHP 5.2.0)');
}

// define a final API request - GET
$api = $url . '/admin/api.php?' . $query;

$request = curl_init($api); // initiate curl object
curl_setopt($request, CURLOPT_HEADER, 0); // set to 0 to eliminate header info from response
curl_setopt($request, CURLOPT_RETURNTRANSFER, 1); // Returns response data instead of TRUE(1)
//curl_setopt($request, CURLOPT_SSL_VERIFYPEER, FALSE); // uncomment if you get no gateway response and are using HTTPS
curl_setopt($request, CURLOPT_FOLLOWLOCATION, true);

$response = (string)curl_exec($request); // execute curl fetch and store results in $response

// additional options may be required depending upon your server configuration
// you can find documentation on curl options at http://www.php.net/curl_setopt
curl_close($request); // close curl object

if ( !$response ) {
	die('Nothing was returned. Do you have a connection to Email Marketing server?');
}

// This line takes the response and breaks it into an array using:
// JSON decoder
//$result = json_decode($response);
// unserializer
$result = unserialize($response);
// XML parser...
// ...

// Result info that is always returned
echo 'Result: ' . ( $result['result_code'] ? 'SUCCESS' : 'FAILED' ) . '<br />';
echo 'Message: ' . $result['result_message'] . '<br />';

// The entire result printed out
echo 'The entire result printed out:<br />';
echo '<pre>';
print_r($result);
echo '</pre>';

// Raw response printed out
echo 'Raw response printed out:<br />';
echo '<pre>';
print_r($response);
echo '</pre>';

// API URL that returned the result
echo 'API URL that returned the result:<br />';
echo $api;?>

Questions? Discuss this API call in our developer forum