email - getcampaigns

API Call Information

area: email

action: getcampaigns

API Arguments

Argument	Data Type	Required	Description
`start`	integer	No	Starting position
`limit`	integer	No	Number of records to return
`id`	string	No	Optional campaign id or comma separated ids 1,2,3,4

API URL Example

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

API Response

XML 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>

JSON Response

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