Call us toll free @ 888-497-7898

email - getcampaigndetail

Get a detailed high level information from a campaign

API Call Information
area: email
action: getcampaigndetail

API Arguments

Argument	Data Type	Required	Description
id	integer	Yes	campaign id found from the getcampaigns api call

API Url Example:
https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=getcampaigndetail&id=149271

API Result:

XML Response

JSON Response

<response>
<campaign>
<id>2145393</id>
<title>
<![CDATA[ab edit test]]>
</title>
<status>Paused</status>
<statusint>501</statusint>
<scheduledate>July 11, 2022,  9:46 am</scheduledate>
<scheduledateiso>2022-07-11T09:46:00Z</scheduledateiso>
<starttime>July 11, 2020,  9:48 am</starttime>
<starttimeiso>2020-07-11T09:48:41Z</starttimeiso>
<endtime>July 11, 2020,  9:49 am</endtime>
<endtimeiso>2020-07-11T09:49:48Z</endtimeiso>
<lastupdate>July 11, 2020,  9:49 am</lastupdate>
<lastupdateiso>2020-07-11T09:49:47Z</lastupdateiso>
<sent>8</sent>
<views>0</views>
<uniqueviews>0</uniqueviews>
<clicks>0</clicks>
<uniqueclicks>0</uniqueclicks>
<optouts>0</optouts>
<conversions>0</conversions>
<fblreports>0</fblreports>
<listid>301604</listid>
<subject>
<![CDATA[test name]]>
</subject>
<rotatedsubject>
<subject>
<![CDATA[computer]]>
</subject>
<subject>
<![CDATA[school]]>
</subject>
<subject>
<![CDATA[another]]>
</subject>
</rotatedsubject>
<messageid>41241</messageid>
<rotatedmessages>
<messageid>44537</messageid>
<messageid>44324</messageid>
<messageid>43493</messageid>
</rotatedmessages>
<sendbehavior/>
<suppression/>
<profileid>176983</profileid>
<domain>ddanieladvertisingagency.com</domain>
<serverid>2167</serverid>
<ips>
<ip>69.94.151.132</ip>
</ips>
<fromname>
<![CDATA[name]]>
</fromname>
<rotatedfromnames>
<fromname>
<![CDATA[jill]]>
</fromname>
<fromname>
<![CDATA[agagagd]]>
</fromname>
<fromname>
<![CDATA[bill]]>
</fromname>
<fromname>
<![CDATA[john]]>
</fromname>
<fromname>
<![CDATA[jeff]]>
</fromname>
</rotatedfromnames>
<fromaddress>paul</fromaddress>
<rotatedfromaddress>
<fromaddress>tim</fromaddress>
<fromaddress>jessica</fromaddress>
<fromaddress>tom</fromaddress>
</rotatedfromaddress>
<sendto>Full</sendto>
<startindex>0</startindex>
<endindex>8</endindex>
<isabtest>Yes</isabtest>
<socialshares>0</socialshares>
<emailsperhour>40000</emailsperhour>
<delivered>6</delivered>
<blocked>0</blocked>
<timedout>2</timedout>
<unknown>0</unknown>
<addressfail>0</addressfail>
<domainfail>0</domainfail>
<retryqueue>0</retryqueue>
<deliveredpercent>75.00%</deliveredpercent>
<blockedpercent>0.00%</blockedpercent>
<timedoutpercent>25.00%</timedoutpercent>
<addressfailpercent>0.00%</addressfailpercent>
<replytoemail/>
<scheduledays>
<Monday>7:00 am - 11:00 am</Monday>
<Tuesday>7:00 am - 11:00 am</Tuesday>
<Wednesday>7:00 am - 11:00 am</Wednesday>
<Thursday>7:00 am - 11:00 am</Thursday>
<Friday>7:00 am - 11:00 am</Friday>
<Saturday>No Sending</Saturday>
<Sunday>No Sending</Sunday>
</scheduledays>
</campaign>
</response>

{
    "campaign": {
        "id": "2145393",
        "title": "ab edit test",
        "status": "Paused",
        "statusint": "501",
        "scheduledate": "July 11, 2022,  9:46 am",
        "scheduledateiso": "2022-07-11T09:46:00Z",
        "starttime": "July 11, 2020,  9:48 am",
        "starttimeiso": "2020-07-11T09:48:41Z",
        "endtime": "July 11, 2020,  9:49 am",
        "endtimeiso": "2020-07-11T09:49:48Z",
        "lastupdate": "July 11, 2020,  9:49 am",
        "lastupdateiso": "2020-07-11T09:49:47Z",
        "sent": "8",
        "views": "0",
        "uniqueviews": "0",
        "clicks": "0",
        "uniqueclicks": "0",
        "optouts": "0",
        "conversions": "0",
        "fblreports": "0",
        "listid": "301604",
        "subject": "test name",
        "rotatedsubject": {
            "subject": [
                "computer",
                "school",
                "another"
            ]
        },
        "messageid": "41241",
        "rotatedmessages": {
            "messageid": [
                "44537",
                "44324",
                "43493"
            ]
        },
        "sendbehavior": "",
        "suppression": "",
        "profileid": "176983",
        "domain": "ddanieladvertisingagency.com",
        "serverid": "2167",
        "ips": {
            "ip": "69.94.151.132"
        },
        "fromname": "name",
        "rotatedfromnames": {
            "fromname": [
                "jill",
                "agagagd",
                "bill",
                "john",
                "jeff"
            ]
        },
        "fromaddress": "paul",
        "rotatedfromaddress": {
            "fromaddress": [
                "tim",
                "jessica",
                "tom"
            ]
        },
        "sendto": "Full",
        "startindex": "0",
        "endindex": "8",
        "isabtest": "Yes",
        "socialshares": "0",
        "emailsperhour": "40000",
        "delivered": "6",
        "blocked": "0",
        "timedout": "2",
        "unknown": "0",
        "addressfail": "0",
        "domainfail": "0",
        "retryqueue": "0",
        "deliveredpercent": "75.00%",
        "blockedpercent": "0.00%",
        "timedoutpercent": "25.00%",
        "addressfailpercent": "0.00%",
        "replytoemail": "",
        "scheduledays": {
            "Monday": "7:00 am - 11:00 am",
            "Tuesday": "7:00 am - 11:00 am",
            "Wednesday": "7:00 am - 11:00 am",
            "Thursday": "7:00 am - 11:00 am",
            "Friday": "7:00 am - 11:00 am",
            "Saturday": "No Sending",
            "Sunday": "No Sending"
        }
    }
}