campaigns – v1.3

 campaigns(string apikey, array filters, int start, int limit)

Get the list of campaigns and their details matching the specified filters

Section
Campaign Related

Parameters
apikey	a valid API Key for your user account. Get by visiting your API dashboard
filters	a hash of filters to apply to this query - all are optional: string campaign_id optional - return the campaign using a know campaign_id. Accepts multiples separated by commas when not using exact matching. string list_id optional - the list to send this campaign to- get lists using lists(). Accepts multiples separated by commas when not using exact matching. int folder_id optional - only show campaigns from this folder id - get folders using campaignFolders(). Accepts multiples separated by commas when not using exact matching. int template_id optional - only show campaigns using this template id - get templates using templates(). Accepts multiples separated by commas when not using exact matching. string status optional - return campaigns of a specific status - one of "sent", "save", "paused", "schedule", "sending". Accepts multiples separated by commas when not using exact matching. string type optional - return campaigns of a specific type - one of "regular", "plaintext", "absplit", "rss", "auto". Accepts multiples separated by commas when not using exact matching. string from_name optional - only show campaigns that have this "From Name" string from_email optional - only show campaigns that have this "Reply-to Email" string title optional - only show campaigns that have this title string subject optional - only show campaigns that have this subject string sendtime_start optional - only show campaigns that have been sent since this date/time (in GMT) - format is YYYY-MM-DD HH:mm:ss (24hr) string sendtime_end optional - only show campaigns that have been sent before this date/time (in GMT) - format is YYYY-MM-DD HH:mm:ss (24hr) boolean exact optional - flag for whether to filter on exact values when filtering, or search within content for filter values - defaults to true. Using this disables the use of any filters that accept multiples.
start	optional - control paging of campaigns, start results at this campaign #, defaults to 1st page of data (page 0)
limit	optional - control paging of campaigns, number of campaigns to return with each call, defaults to 25 (max=1000)

Returns

array

an array containing a count of all matching campaigns and the specific ones for the current page (see Returned Fields for description) int total the total number of campaigns matching the filters passed in array data the data for each campaign being returned string id Campaign Id (used for all other campaign functions) int web_id The Campaign id used in our web app, allows you to create a link directly to it string list_id The List used for this campaign int folder_id The Folder this campaign is in int template_id The Template this campaign uses string content_type How the campaign's content is put together - one of 'template', 'html', 'url' string title Title of the campaign string type The type of campaign this is (regular,plaintext,absplit,rss,inspection,auto) string create_time Creation time for the campaign string send_time Send time for the campaign - also the scheduled time for scheduled campaigns. int emails_sent Number of emails email was sent to string status Status of the given campaign (save,paused,schedule,sending,sent) string from_name From name of the given campaign string from_email Reply-to email of the given campaign string subject Subject of the given campaign string to_name Custom "To:" email string using merge variables string archive_url Archive link for the given campaign boolean inline_css Whether or not the campaign content's css was auto-inlined string analytics Either "google" if enabled or "N" if disabled string analytics_tag The name/tag the campaign's links were tagged with if analytics were enabled. boolean authenticate Whether or not the campaign was authenticated boolean ecomm360 Whether or not ecomm360 tracking was appended to links boolean auto_tweet Whether or not the campaign was auto tweeted after sending string auto_fb_post A comma delimited list of Facebook Profile/Page Ids the campaign was posted to after sending. If not used, blank. boolean auto_footer Whether or not the auto_footer was manually turned on boolean timewarp Whether or not the campaign used Timewarp string timewarp_schedule The time, in GMT, that the Timewarp campaign is being sent. For A/B Split campaigns, this is blank and is instead in their schedule_a and schedule_b in the type_opts array array tracking the various tracking options used boolean html_clicks whether or not tracking for html clicks was enabled. boolean text_clicks whether or not tracking for text clicks was enabled. boolean opens whether or not opens tracking was enabled. string segment_text a string marked-up with HTML explaining the segment used for the campaign in plain English array segment_opts the segment used for the campaign - can be passed to campaignSegmentTest() or campaignCreate() array type_opts the type-specific options for the campaign - can be passed to campaignCreate()

Examples (2)

download example code

[1] mcapi_campaigns.php

<?php
/**
This Example shows how to retrieve a list of your campaigns via the MCAPI class.
**/
require_once 'inc/MCAPI.class.php';
require_once 'inc/config.inc.php'; //contains apikey
 
$api = new MCAPI($apikey);
 
$retval = $api->campaigns();
 
if ($api->errorCode){
	echo "Unable to Pull list of Campaign!";
	echo "\n\tCode=".$api->errorCode;
	echo "\n\tMsg=".$api->errorMessage."\n";
} else {
    echo sizeof($retval['total'])." Total Campaigns Matched.\n";
    echo sizeof($retval['data'])." Total Campaigns returned:\n";
    foreach($retval['data'] as $c){
        echo "Campaign Id: ".$c['id']." - ".$c['title']."\n";
        echo "\tStatus: ".$c['status']." - type = ".$c['type']."\n";
        echo "\tsent: ".$c['send_time']." to ".$c['emails_sent']." members\n";
    }
}
 
?>
 

[2] xml-rpc_campaigns.php

<?php
/**
This Example shows how to pull a list of Campaigns on your account using XML-RPC
Note that we are using the PEAR XML-RPC2 client and recommend others do as well.
**/
require_once 'XML/RPC2/Client.php';
require_once 'inc/config.inc.php';
try {
    $client = XML_RPC2_Client::create($apiUrl);
 
    $result = $client->campaigns($apikey);
    echo sizeof($result['total'])." Total Campaigns Matched.\n";
    echo sizeof($result['data'])." Campaigns returned:\n";
    foreach($result['data'] as $c){
        echo "Campaign Id: ".$c['id']." - ".$c['title']."\n";
        echo "\tStatus: ".$c['status']." - type = ".$c['type']."\n";
        echo "\tsent: ".$c['send_time']." to ".$c['emails_sent']." members\n";
    }
} catch (XML_RPC2_FaultException $e){
	echo "ERROR!!!!\n";
	echo $e->getFaultCode()." : ".$e->getFaultString()."\n";
}
 
?>