Log in Talk to an expert

getcampaigns

area emailaction getcampaignsGETread

Returns a list of campaigns from the account.

Arguments

ArgumentTypeRequiredDescription
startintegerNoStarting position
limitintegerNoNumber of records to return
idstringNoOptional campaign id or comma separated ids 1,2,3,4

Example request

https://api.mailclickconvert.com/api.php
  ?apikey=YOUR_API_KEY
  &area=email
  &action=getcampaigns
  &start=0
  &limit=10

Response

<response>
  <records>2</records>
  <campaign>
    <id>149271</id>
    <title>test</title>
    <status>Completed</status>
    <scheduledate>October 11, 2011, 11:38:00 pm</scheduledate>
    <starttime>October 11, 2011, 11:41:36 pm</starttime>
    <endtime>October 11, 2011, 11:43:06 pm</endtime>
    <lastupdate/>
    <sent>2</sent>
    <views>0</views>
    <uniqueviews>0</uniqueviews>
    <clicks>0</clicks>
    <uniqueclicks>0</uniqueclicks>
    <optouts>0</optouts>
    <conversions>2</conversions>
  </campaign>
  <campaign>
    <id>137884</id>
    <title>gagaga</title>
    <status>Pausing</status>
    <scheduledate>July 31, 2013, 05:54:00 pm</scheduledate>
    <starttime/>
    <endtime/>
    <lastupdate/>
    <sent>0</sent>
    <views>0</views>
    <uniqueviews>0</uniqueviews>
    <clicks>0</clicks>
    <uniqueclicks>0</uniqueclicks>
    <optouts>0</optouts>
    <conversions>0</conversions>
  </campaign>
</response>
Related

More in Campaigns.

blreport

POSTwrite

Gets list of blocked responses from a campaign that appear to be from blacklists

campaignlog

GETread

Gets the details of a campaign from the campaign log. For each chunk update. This data builds the campaign graph.

createcampaign

POSTdestructive

Sends an email campaign

deletecampaign

POSTdestructive

Deletes a campaign given a campaign id

deletereoccurringcampaign

POSTdestructive

Deletes a recurring campaign given the recurring id

deletetrigger

POSTdestructive

Deletes a trigger given a trigger id

Need a call that isn't here?

Custom integration work is quoted on scope, and support is a person on weekdays, 9am to 5pm CST.

Talk to usBack to the API list