Call us toll free @ 888-497-7898

email - getcampaignresults

Shows each individual email delivery result from a campaign.


API Call Information
area: email
action: getcampaignresults

API Arguments
Argument Data Type Required Description
id integer Yes ID of the campaign to get the results from
filter string No Optionally can either be set to soffbounces,hardbounces,delivered, or do not enter anything and will return all the data.
start integer No Starting position for paging
limit integer No Number of records to return
API Url Example:
https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=getcampaignresults&id=1055353

API Result:
XML Response JSON Response
<response>
  <records>16</records>
  <log>
    <email><![CDATA[test@test.com]]></email>
    <emaildomain><![CDATA[gmail.com]]></emaildomain>
    <status><![CDATA[Blocked]]></status>
    <clickts><![CDATA[]]></clickts>
    <viewts><![CDATA[]]></viewts>
    <clickip><![CDATA[]]></clickip>
    <viewip><![CDATA[]]></viewip>
    <engagementscore><![CDATA[0]]></engagementscore>
    <softbouncecount><![CDATA[1]]></softbouncecount>
    <lastmailsendts><![CDATA[July 30, 2025, 12:30:12 pm]]></lastmailsendts>
    <total_sends><![CDATA[1]]></total_sends>
    <email_tags><![CDATA[]]></email_tags>
    <emailid><![CDATA[5]]></emailid>
    <debugreason><![CDATA[421-Connection Closed Gracefully.]]></debugreason>
    <firstname><![CDATA[]]></firstname>
  </log>
  <log>
    <email><![CDATA[test@test.com]]></email>
    <emaildomain><![CDATA[zohomail.com]]></emaildomain>
    <status><![CDATA[Blocked]]></status>
    <clickts><![CDATA[]]></clickts>
    <viewts><![CDATA[]]></viewts>
    <clickip><![CDATA[]]></clickip>
    <viewip><![CDATA[]]></viewip>
    <engagementscore><![CDATA[0]]></engagementscore>
    <softbouncecount><![CDATA[1]]></softbouncecount>
    <lastmailsendts><![CDATA[July 30, 2025, 12:30:20 pm]]></lastmailsendts>
    <total_sends><![CDATA[1]]></total_sends>
    <email_tags><![CDATA[]]></email_tags>
    <emailid><![CDATA[7]]></emailid>
    <debugreason><![CDATA[250-Mail rejected due to antispam policy]]></debugreason>
    <firstname><![CDATA[]]></firstname>
  </log>
</response>
{
    "records": "16",
    "log": [
        {
            "email": "test@test.com",
            "emaildomain": "gmail.com",
            "status": "Blocked",
            "clickts": "",
            "viewts": "",
            "clickip": "",
            "viewip": "",
            "engagementscore": "0",
            "softbouncecount": "1",
            "lastmailsendts": "July 30, 2025, 12:30:12 pm",
            "total_sends": "1",
            "email_tags": "",
            "emailid": "5",
            "debugreason": "421-Connection Closed Gracefully.",
            "firstname": ""
        },
        {
            "email": "test@test.com",
            "emaildomain": "zohomail.com",
            "status": "Blocked",
            "clickts": "",
            "viewts": "",
            "clickip": "",
            "viewip": "",
            "engagementscore": "0",
            "softbouncecount": "1",
            "lastmailsendts": "July 30, 2025, 12:30:20 pm",
            "total_sends": "1",
            "email_tags": "",
            "emailid": "7",
            "debugreason": "250-Mail rejected due to antispam policy",
            "firstname": ""
        }
    ]
}