CampaignResult

Permission Required to use this API Endpoint

Email Campaign – Can Edit All

Get all outbound campaign results

This is all gathered campaign results for a campaign, containing data on which users clicked or otherwise interacted with the phishing exercise.

GET /rest/campaignresults/id/afterid

Parameters

Example Usage

curl -X GET -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -H "Cache-Control: no-cache" "https://api.phishline.com/phishline_example/rest/campaignresults/11"

Paging

Paging is required if the request will return more than 5,000 records. The HTTP status code will be set to 206 – Partial Content. 

To get subsequent pages you must pass the maxIdReturned from the current request to the next request as the afterid. Continue to do this until all the rows are returned and the remainingRowCount is zero and/or the HTTP status code returned is 200.

Example Usage with Paging

curl -X GET -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -H "Cache-Control: no-cache" "https://api.phishline.com/phishline_example/rest/campaigns/1234234234/563311"

Success Response Example

Note the following values indicate that paging is needed.

• status code changes from 200 to 206
• statusMessage changes from OK to PartialContent
• remainingRowCount changes from zero to greater than zero

HTTP/1.1 200 OK
{
    "status": 200,
    "statusMessage": "OK",
    "statusDetails": {
        "Total Results": 1
    },
    "entity": "campaignresult",
    "jobid": 0,
    "notifications": {
        "API Token Expiration Date": "2019-09-21 11:15:09",
        "Maximum API calls per hour": 1000,
        "Your API calls in the last hour": 9
    },
    "totalRowCount": 1,
    "pageRowCount": 1,
    "remainingRowCount": 0,
    "maxIdReturned": 1021,
    "data": [
        {
            "outboundid": "1021",
            "messageid": "e7fd0faacbd",
            "status": "Sent",
            "year": "2018",
            "yearQuarter": "2018-Q3",
            "yearMonth": "2018-07",
            "yearWeek": "2018-27",
            "dayOfWeek": "6",
            "hourOfDay": "18",
            "subject": "Background check requested",
            "to": "user.example@phishline.com",
            "cc": "",
            "bcc": "",
            "contentType": "multipart\/alternative; charset=\"UTF-8\"; boundary=\"_010e7fd0faacbdg743477160_\"",
            "replyTo": "\"Privacy Notifier\" <hrdept@corporateintranet.net>",
            "sender": "\"Privacy Notifier\" <hrdept@corporateintranet.net>",
            "locked": "1",
            "sent": "1",
            "sending": "0",
            "sendAttempts": "1",
            "sendAfter": "2018-07-08 18:31:00",
            "scheduledTimezoneActual": "2018-07-08 18:31 (Friday) America\/Chicago UTC-5",
            "sendDate": "2018-07-08 18:31:05",
            "campaignName": "Test Campaign from TestCafe",
            "campaignType": "Email Campaign",
            "campaignActive": "1",
            "planName": "Assessing current user abilities",
            "planid": "1",
            "campaignCategory": "none",
            "campaignStartDate": "2018-07-07 13:46:00",
            "campaignEndDate": "2018-07-22 13:46:00",
            "campaignCutoffDate": "2018-07-29 13:46:00",
            "campaignEmailCountMax": "1",
            "campaignModeSMS": "0",
            "campaignModeVoice": "0",
            "campaignModeAutomated": "0",
            "campaignIntent": "Testing",
            "campaignLifecycle": "Completed",
            "campaignLocked": "0",
            "emailaddressbookid": "21",
            "addressBookName": "N\/A",
            "addressBookActive": "0",
            "addressBookCategory": "N\/A",
            "emailserverid": "341",
            "emailServerName": "corporateintranet.net - hrdept",
            "emailServerType": "Email",
            "emailServerActive": "1",
            "emailServerSender": "hrdept@corporateintranet.net",
            "emailServerReplyTo": "hrdept@corporateintranet.net",
            "emailServerDailySendLimit": "0",
            "emailServerMaxRetries": "6",
            "emailServerRetryHourIncrement": "2",
            "emailServerModeEmail": "0",
            "emailServerModeSMS": "0",
            "emailServerModeVoice": "0",
            "emailServercentralphoneid": "0",
            "emailServerCentralPhoneNumber": "0",
            "emailtemplateid": "31",
            "emailTemplateGUID": "aee2b7e43ae0562fc6e571b88874a4e3",
            "emailTemplateName": "Background Check",
            "emailTemplateType": "Email",
            "emailTemplateActive": "1",
            "emailTemplateCategory": "Legal",
            "emailTemplateSenderName": "Privacy Notifier",
            "emailTemplateSubject": "Background check requested",
            "emailTemplateEnableHTML": "1",
            "emailTemplateMaxAttachments": "0",
            "emailTemplateModeEmail": "1",
            "emailTemplateModeSMS": "0",
            "emailTemplateModeVoice": "0",
            "emailTemplateIsUrgent": "0",
            "emailTemplateEnableInlineImages": "0",
            "webserverid": "181",
            "webServerName": "http:\/\/corporateintranet.net",
            "webServerType": "Web Server",
            "webServerActive": "1",
            "webServerURL": "http:\/\/corporateintranet.net\/de44001f181",
            "webServerModeVoice": "0",
            "webServerURLSSL": "0",
            "webServerURLHost": "corporateintranet.net",
            "webServerURLTiny": "0",
            "webtemplateid": "11",
            "webTemplateGUID": "812798dd391ec4a869c2d89424583812",
            "webTemplateName": "Employee Benefits Portal",
            "webTemplateType": "Web Page",
            "webTemplateActive": "1",
            "webTemplateCategory": "Login",
            "webTemplateURLBaseDir": "812798dd391ec4a869c2d894",
            "webTemplateURLBaseFile": "index.php",
            "link": "http:\/\/corporateintranet.net\/de44001f181\/812798dd391ec4a869c2d894\/index.php",
            "linkText": "Link",
            "attach": "http:\/\/corporateintranet.net\/de44001f181\/812798dd391ec4a869c2d894\/download.php",
            "img": "http:\/\/corporateintranet.net\/de44001f181\/812798dd391ec4a869c2d894\/img.php",
            "unsubscribe": "http:\/\/corporateintranet.net\/de44001f181\/812798dd391ec4a869c2d894\/unsubscribe.php",
            "unsubscribeText": "Unsubscribe",
            "webTemplateModeVoice": "0",
            "webTemplateivrid": "0",
            "webTemplateIVRName": "",
            "webTemplateServerExplodedStatus": "Current",
            "webTemplateServerExplodedPublished": "True",
            "webTemplateServerExplodedValidated": "True",
            "webTemplateServerExplodedLastPublished": "2018-09-07 22:23:01",
            "webTemplateServerExplodedLastValidated": "2018-06-25 16:58:28",
            "emailaddressid": "1021",
            "addressAddress": "user.example@phishline.com",
            "addressActive": "1",
            "addressAtRestricted": "0",
            "addressAtDomain": "@phishline.com",
            "addressAnonymized": "0",
            "addressFirstName": "User",
            "addressLastName": "Example",
            "addressFullName": "",
            "addressPersonalTitle": "",
            "addressNameSuffix": "",
            "addressOrgArea": "N\/A",
            "addressOrgLevel": "N\/A",
            "addressOrgTenure": "N\/A",
            "addressCompany": "",
            "addressCountry": "",
            "addressRegion": "",
            "addressSite": "",
            "addressLanguage": "",
            "addressTimeZone": "",
            "addressStreet": "",
            "addressCity": "",
            "addressState": "",
            "addressZip": "",
            "addressMobile": "",
            "addressOtherMobile": "",
            "addressSource": "",
            "addressCustom1": "",
            "addressCustom2": "",
            "addressCustom3": "",
            "addressCustom4": "",
            "addressCustom5": "",
            "addressCustom6": "",
            "addressCustom7": "",
            "addressCustom8": "",
            "addressCustom9": "",
            "addressCustom10": "",
            "addressCustom11": "",
            "addressCustom12": "",
            "addressCustom13": "",
            "addressCustom14": "",
            "addressCustom15": "",
            "addressCustom16": "",
            "addressCustom17": "",
            "addressCustom18": "",
            "addressCustom19": "",
            "addressCustom20": "",
            "addressCustom21": "N\/A",
            "addressCustom22": "N\/A",
            "addressCustom23": "N\/A",
            "addressCustom24": "N\/A",
            "addressCustom25": "N\/A",
            "addressCustom26": "N\/A",
            "addressCustom27": "N\/A",
            "addressCustom28": "N\/A",
            "addressCustom29": "N\/A",
            "addressCustom30": "N\/A",
            "addressCustom31": "N\/A",
            "addressCustom32": "N\/A",
            "addressCustom33": "N\/A",
            "addressCustom34": "N\/A",
            "addressCustom35": "N\/A",
            "addressCustom36": "N\/A",
            "addressCustom37": "N\/A",
            "addressCustom38": "N\/A",
            "addressCustom39": "N\/A",
            "addressCustom40": "N\/A",
            "addressOffenderCategory": "Non-Offender",
            "addressOffenderFailureNumber": "0",
            "addressOffenderCampaignList": "",
            "addressTraining": "0",
            "addressTrainingPassed": "0",
            "addressTrainingCompleted": "0",
            "addressTotalEventPoints": "100",
            "undeliverable": "0",
            "outOfOffice": "0",
            "senderAddressVerification": "0",
            "replyReceived": "0",
            "replyOrActivity": "0",
            "opp": "0",
            "activity": "0",
            "oppPageView": "1",
            "activityPageView": "0",
            "oppImageView": "0",
            "activityImageView": "0",
            "oppFileDownload": "1",
            "activityFileDownload": "0",
            "oppLoginForm": "1",
            "activityLoginForm": "0",
            "activityUser": "0",
            "activityPw": "0",
            "oppFeedbackForm": "0",
            "activityFeedbackForm": "0",
            "activityTopic": "0",
            "activitySender": "0",
            "activityMessage": "0",
            "oppFileUpload": "0",
            "activityFileUpload": "0",
            "oppCaptcha": "0",
            "activityCaptcha": "0",
            "oppUnsubscribePageView": "0",
            "activityUnsubscribePageView": "0",
            "activityUnsubscribeForm": "0",
            "oppIncidentResponse": "0",
            "activityIncidentResponse": "0",
            "oppSmartAttachment": "0",
            "activitySmartAttachment": "0",
            "oppSmartAttachmentRunnable": "0",
            "activitySmartAttachmentRunnable": "0",
            "messageType": "Email",
            "clickReporterActionSummary": "No Click and No Report",
            "multiClicker": "0",
            "osList": "N\/A",
            "pluginsCPEList": "",
            "messageEventPoints": "100",
			"lastSendAttemptError": "",
            "messageTotalEventPoints": "0",
            "programtermaddressid": "11",
            "programRollingTermTargetedCount": "93",
            "programRollingTermPageViewCount": "7",
            "programRollingTermReportedCount": "0",
            "programRollingTermPageViewRate": "7.53",
            "programRollingTermReportedRate": "0.00",
            "programRollingTermMultiClicker": "1",
            "programRollingTermConsecutiveClicker": "1",
            "programRollingTermChronicClicker": "0",
            "programRollingTermReportingDate": "2018-07-08",
            "programRollingTermReportingTermName": "2018-07",
            "firstSurveyTemplateStarted": "",
            "listSurveyTemplatesStarted": "",
            "timeInSecondsSpentOnPageForOutboundMessage": "0",
            "timeInMinutesSpentOnPageForOutboundMessage": "0.00",
            "timeInSecondsSpentTrainingForOutboundMessage": "0",
            "timeInMinutesSpentTrainingForOutboundMessage": "0.00",
            "firstClickTime": "0000-00-00 00:00:00",
            "firstReportedTime": "0000-00-00 00:00:00",
            "firstClickMinutes": "0",
            "firstReportedMinutes": "0",
            "emailTraining": "0",
            "emailTrainingPassed": "0",
            "emailTrainingCompleted": "0",
            "campaignid": "11"
        }
    ]
}

Success 200

Error 4xx

Error Response Examples

HTTP/1.1 401 Not Authorized
{
    "status": 401,
    "statusMessage": "NotAuthorized",
    "statusDetails": {
        "Reason": "Valid access token required. Please re-authenticate."
    },
    "entity": "unknown",
    "jobid": 0,
    "notifications": [],
    "data": []
}

HTTP/1.1 404 Not Found
{
    "status": 404,
    "statusMessage": "Not Found",
    "statusDetails": {
        "Reason": "No campaign stats found for id 12342323."
    },
    "entity": "unknown",
    "jobid": 0,
    "notifications": [],
    "data": []
}