We use cookies on our website to ensure we provide you with the best experience on our website. By using our website, you agree to the use of cookies for analytics and personalized content.This website uses cookies. More Information
It seems like your browser didn't download the required fonts. Please revise your security settings and try again.

CampaignResult

  • Last updated on

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 /campaignresults/id/afterid
Parameters
NameTypeDescription
idInteger

The Campaign ID.

afteridIntegerOptional – Use when Paging is required. Each request now returns the maxIdReturned. Use this value as the afterid to retrieve the next page of records if necessary. See Paging below for more details.
access_tokenString

Set the access token if you have not added it as an Authorization header.

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
NameTypeDescription
campaignresultObject[]

A campaign outbound result record for a single email address.

campaignresult.activityBoolean 
campaignresult.activityCaptchaBooleanHas the user of this email address ever submitted an image Captcha form?
campaignresult.activityFeedbackFormBooleanHas the user of this email address ever submitted a Feedback Form?
campaignresult.activityFileDownloadBooleanHas the user of this email address ever performed an Action File Download?
campaignresult.activityFileUploadBooleanHas the user of this email address ever uploaded a file to a form?
campaignresult.activityImageViewBooleanHas the user of this email address ever performed an Action Image View?
campaignresult.activityIncidentResponseBooleanHas the user of this email address ever forwarded an email to an approved Incident Response Repository?
campaignresult.activityLoginFormBooleanHas the user of this email address ever submitted a Login form?
campaignresult.activityMessageBoolean 
campaignresult.activityPageViewBoolean 
campaignresult.activityPwBooleanHas the user of this email address ever submitted a Password on a Login form?
campaignresult.activitySenderBoolean 
campaignresult.activitySmartAttachmentBooleanHas the user of this email address ever arrived at a landing page due to an interaction with a Smart Attachment?
campaignresult.activitySmartAttachmentRunnableBooleanHas the user of this email address ever arrived at a landing page by Running/Executing a Smart Attachment EXE or macro?
campaignresult.activityTopicBoolean 
campaignresult.activityUnsubscribeFormBooleanHas the user of this email address ever submitted an Unsubscribe form?
campaignresult.activityUnsubscribePageViewBooleanHas the user of this email address ever viewed an Unsubscribe form?
campaignresult.activityUserBoolean 
campaignresult.addressActiveNumber 
campaignresult.addressAddressString 
campaignresult.addressAnonymizedStringHave the details of this email address entry been deactivated and replaced with Anonymous data?
campaignresult.addressAtDomainStringThe domain information, located to the right of the @ sign.
campaignresult.addressAtRestrictedNumberThis field is no longer used and will be removed in a future release.
campaignresult.addressBookActiveNumber 
campaignresult.addressBookCategoryString 
campaignresult.addressBookNameStringName of the address book containing this address entry.
campaignresult.addressCityStringThe geographic City corresponding to this email address entry.
campaignresult.addressCompanyStringOrganization associated with this email address book entry. 
campaignresult.addressCountryStringGeographic Country corresponding to this email address book entry.
campaignresult.addressCustom1StringCustom email address attributes used for advanced campaign targeting and analysis.
campaignresult.addressCustom2String" "
campaignresult.addressCustom3String" "
campaignresult.addressCustom4String" "
campaignresult.addressCustom5String" "
campaignresult.addressCustom6String" "
campaignresult.addressCustom7String" "
campaignresult.addressCustom8String" "
campaignresult.addressCustom9String" "
campaignresult.addressCustom10String" "
campaignresult.addressCustom11String" "
campaignresult.addressCustom12String" "
campaignresult.addressCustom13String" "
campaignresult.addressCustom14String" "
campaignresult.addressCustom15String" "
campaignresult.addressCustom16String" "
campaignresult.addressCustom17String" "
campaignresult.addressCustom18String" "
campaignresult.addressCustom19String" "
campaignresult.addressCustom20String" "
campaignresult.addressCustom21String" "
campaignresult.addressCustom22String" "
campaignresult.addressCustom23String" "
campaignresult.addressCustom24String" "
campaignresult.addressCustom25String" "
campaignresult.addressCustom26String" "
campaignresult.addressCustom27String" "
campaignresult.addressCustom28String" "
campaignresult.addressCustom29String" "
campaignresult.addressCustom30String" "
campaignresult.addressCustom31String" "
campaignresult.addressCustom32String" "
campaignresult.addressCustom33String" "
campaignresult.addressCustom34String" "
campaignresult.addressCustom35String" "
campaignresult.addressCustom36String" "
campaignresult.addressCustom37String" "
campaignresult.addressCustom38String" "
campaignresult.addressCustom39String" "
campaignresult.addressCustom40String" "
campaignresult.addressOffenderCategoryString 
campaignresult.addressOffenderFailureNumberString 
campaignresult.addressOffenderCampaignListString 
campaignresult.addressFirstNameStringFirst name associated with the contact email address.
campaignresult.addressFullNameStringComplete name associated with the contact email address, usually consisting of the first and last name, but can also include a middle name. 
campaignresult.addressLanguageStringLanguage Code, typically the ISO language/region code, corresponding to this email address book entry.
campaignresult.addressLastNameStringLast name associated with the contact email address. 
campaignresult.addressMobileStringPhone number that can be used for text messaging tests. 
campaignresult.addressNameSuffixStringName suffix (like Jr. or Sr.) associated with this email address.
campaignresult.addressOrgAreaStringPart of the organization, like department or division, corresponding to the email address entry.
campaignresult.addressOrgLevelStringTitle or management level corresponding to the email address entry.
campaignresult.addressOrgTenureStringHow long the user of this email address has been with the organization. Can be numerical or alphabetical entry.
campaignresult.addressOtherMobileStringAdditional mobile phone number????
campaignresult.addressPersonalTitleStringTitle associated with the contact email address, such as Dr., Mr., Ms., and so on.
campaignresult.addressRegionStringGeographic region where the email address is located, like EMEA or Northeast. You can also choose to use ISO region codes.
campaignresult.addressSiteStringDescriptor for the location of the email address, like Manufacturing or Downtown Branch.
campaignresult.addressSourceStringThe source of the email address. This field can be an Open Source Intelligence source or perhaps data from human resources or a response from a certain marketing campaign.
campaignresult.addressStateStringGeographic state corresponding to the email address entry.
campaignresult.addressStreetStringGeographic street address corresponding to the email address entry.
campaignresult.addressTimeZoneStringTime zone associated with this contact email address.
campaignresult.addressTotalEventPointsNumberPoints associated with this email address, as described in Points Manager, specified as a range from at least to at most.
campaignresult.addressTrainingBooleanHas the user of this email address ever clicked on an Online Training Challenge?
campaignresult.addressTrainingCompletedBooleanHas the user associated with this email address ever completed a Training Challenge?
campaignresult.addressTrainingPassedBooleanHas the user of this email address ever received a passing grade on a Training Challenge?
campaignresult.addressZipStringZip or other postal code for the geographical address corresponding to the email address entry.
campaignresult.attachString 
campaignresult.bccString 
campaignresult.campaignActiveNumberIs this email address available for campaigns?
campaignresult.campaignCategoryString 
campaignresult.campaignCutoffDateDate 
campaignresult.campaignEmailCountMaxNumber 
campaignresult.campaignEndDateDate 
campaignresult.campaignIntentString 
campaignresult.campaignLifecycleString 
campaignresult.campaignLockedBoolean

Is the campaign locked because it is at least 30 days past the cutoff date?

campaignresult.campaignModeAutomatedNumber 
campaignresult.campaignModeSMSNumber 
campaignresult.campaignModeVoiceNumber 
campaignresult.campaignNameString 
campaignresult.campaignStartDateDate 
campaignresult.campaignTypeString 
campaignresult.ccString 
campaignresult.clickReporterActionSummaryString 
campaignresult.contentTypeString 
campaignresult.dayOfWeekString 
campaignresult.emailaddressbookidNumber 
campaignresult.emailaddressidNumber 
campaignresult.emailcampaignidNumber 
campaignresult.emailServerActiveNumber 
campaignresult.emailServerDailySendLimitNumber 
campaignresult.emailserveridNumber 
campaignresult.emailServerMaxRetriesNumber 
campaignresult.emailServerModeSMSNumber 
campaignresult.emailServerModeVoiceNumber 
campaignresult.emailServerNameString 
campaignresult.emailServerReplyToString 
campaignresult.emailServerRetryHourIncrementNumber 
campaignresult.emailServerSenderString 
campaignresult.emailServerTypeString 
campaignresult.emailServerCentralPhoneNumberString 
campaignresult.emailServerModeEmailString 
campaignresult.emailServercentralphoneidString 
campaignresult.emailTemplateActiveNumber 
campaignresult.emailTemplateCategoryString 
campaignresult.emailTemplateEnableHTMLNumber 
campaignresult.emailTemplateEnableInlineImagesNumber 
campaignresult.emailTemplateGUIDString 
campaignresult.emailtemplateidNumber 
campaignresult.emailTemplateMaxAttachmentsNumber 
campaignresult.emailTemplateNameString 
campaignresult.emailTemplateSenderNameString 
campaignresult.emailTemplateSubjectString 
campaignresult.emailTemplateTypeString 
campaignresult.emailTemplateIsUrgentString 
campaignresult.emailTemplateModeEmailString 
campaignresult.emailTemplateModeSMSString 
campaignresult.emailTemplateModeVoiceString 
campaignresult.emailTrainingBoolean 
campaignresult.emailTrainingCompletedBoolean 
campaignresult.emailTrainingPassedBoolean 
campaignresult.firstClickMinutesNumber 
campaignresult.firstClickTimeDate 
campaignresult.firstReportedMinutesNumber 
campaignresult.firstReportedTimeDate 
campaignresult.firstSurveyTemplateStartedString 
campaignresult.hourOfDayNumber 
campaignresult.imgString 
campaignresult.linkString 
campaignresult.linkTextString 
campaignresult.listSurveyTemplatesStartedString 
campaignresult.lockedBoolean 
campaignresult.messageidString 
campaignresult.messageTotalEventPointsNumber 
campaignresult.programtermaddressidNumber 
campaignresult.timeInMinutesSpentOnPageForOutboundMessageNumber 
campaignresult.timeInMinutesSpentTrainingForOutboundMessageNumber 
campaignresult.timeInSecondsSpentOnPageForOutboundMessageNumber 
campaignresult.timeInSecondsSpentTrainingForOutboundMessageNumber 
campaignresult.webServerModeVoiceString 
campaignresult.webServerURLHostString 
campaignresult.webServerURLSSLString 
campaignresult.webServerURLTinyString 
campaignresult.messageEventPointsNumber 
campaignresult.lastSendAttemptErrorString 
campaignresult.messageTypeString 
campaignresult.multiClickerBoolean 
campaignresult.oppBoolean 
campaignresult.oppCaptchaBoolean 
campaignresult.oppFeedbackFormBoolean 
campaignresult.oppFileDownloadBoolean 
campaignresult.oppFileUploadBoolean 
campaignresult.oppImageViewBoolean 
campaignresult.oppIncidentResponseBoolean 
campaignresult.oppLoginFormBoolean 
campaignresult.oppPageViewBoolean 
campaignresult.oppSmartAttachmentBoolean 
campaignresult.oppSmartAttachmentRunnableBoolean 
campaignresult.oppUnsubscribePageViewBoolean 
campaignresult.osListString 
campaignresult.outboundidNumber 
campaignresult.outOfOfficeBoolean 
campaignresult.planidNumber 
campaignresult.planNameString 
campaignresult.pluginsCPEListString 
campaignresult.programRollingTermChronicClickerNumber 
campaignresult.programRollingTermConsecutiveClickerNumber 
campaignresult.programRollingTermMultiClickerNumber 
campaignresult.programRollingTermPageViewCountNumber 
campaignresult.programRollingTermPageViewRateNumber 
campaignresult.programRollingTermReportedCountNumber 
campaignresult.programRollingTermReportedRateNumber 
campaignresult.programRollingTermReportingDateDate 
campaignresult.programRollingTermReportingTermNameString 
campaignresult.programRollingTermTargetedCountNumber 
campaignresult.replyOrActivityBoolean 
campaignresult.replyReceivedBoolean 
campaignresult.replyToString 
campaignresult.scheduledTimezoneActualString 
campaignresult.sendAfterDate 
campaignresult.sendAttemptsNumber 
campaignresult.sendDateDate 
campaignresult.senderString 
campaignresult.senderAddressVerificationBoolean 
campaignresult.sendingBoolean 
campaignresult.sentBoolean 
campaignresult.statusString 
campaignresult.subjectString 
campaignresult.timeSpentOnPageDirtyBoolean

Does the time spent on page need to be recalculated?

campaignresult.toString 
campaignresult.undeliverableBoolean 
campaignresult.unsubscribeString 
campaignresult.unsubscribeTextString 
campaignresult.webServerActiveNumber 
campaignresult.webserveridNumber 
campaignresult.webServerNameString 
campaignresult.webServerTypeString 
campaignresult.webServerURLString 
campaignresult.webTemplateActiveNumber 
campaignresult.webTemplateCategoryString 
campaignresult.webTemplateGUIDString 
campaignresult.webtemplateidNumber 
campaignresult.webTemplateivridNumber 
campaignresult.webTemplateIVRNameString 
campaignresult.webTemplateModeVoiceNumber 
campaignresult.webTemplateNameString 
campaignresult.webTemplateServerExplodedLastPublishedDate 
campaignresult.webTemplateServerExplodedLastValidatedDate 
campaignresult.webTemplateServerExplodedPublishedString 
campaignresult.webTemplateServerExplodedStatusString 
campaignresult.webTemplateServerExplodedValidatedString 
campaignresult.webTemplateTypeString 
campaignresult.webTemplateURLBaseDirString 
campaignresult.webTemplateURLBaseFileString 
campaignresult.yearString 
campaignresult.yearMonthString 
campaignresult.yearQuarterString 
campaignresult.yearWeekString 
Error 4xx
NameTypeDescription
NotAuthorized 

Only authorized users can access this data.

NotFound The id of the Campaign was not found.
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": []
}

Get aggregate summarized campaign result data

Get high-level summary statistical data for a specific campaign ID.

GET /campaignresultstats/:id
Parameters

 

NameTypeDescription
idString

The Campaign ID.

access_tokenString

Set the access token if you have not added it as an Authorization header.

Example Usage
curl -X GET -H "Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" -H "Cache-Control: no-cache" "https://api.phishline.com/phishline_example/rest/campaignresultstats/1"
Success Response Example
HTTP/1.1 200 OK
{
    "status": 200,
    "statusMessage": "OK",
    "statusDetails": {
        "Total Results": 18
    },
    "entity": "campaignresultstat",
    "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": 32
    },
    "data": [
        {
            "category": "Outbound",
            "metric": "Emails Scheduled",
            "count": "1",
            "opportunity": "1",
            "percent": "100.000",
            "description": "The # of emails scheduled through a Campaign.",
            "id": "11",
            "campaignid": "11"
        },
        {
            "category": "User Response",
            "metric": "Reply Received",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails where the user sent a reply.",
            "id": "11441",
            "campaignid": "11"
        },
        {
            "category": "Critical User Response",
            "metric": "Unsubscribe Form Submitted",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails where the user submitted a non-blank unsubscribe form.",
            "id": "10811",
            "campaignid": "11"
        },
        {
            "category": "Critical User Response",
            "metric": "File Uploaded",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails where the user uploaded a file on a landing page form.",
            "id": "10181",
            "campaignid": "11"
        },
        {
            "category": "User Response",
            "metric": "Captcha Submitted",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails where the user submitted a non-blank Captcha response on the landing page.",
            "id": "9551",
            "campaignid": "11"
        },
        {
            "category": "User Response",
            "metric": "Feedback Form Submitted",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails where the user submitted a feedback form on the landing page.",
            "id": "8921",
            "campaignid": "11"
        },
        {
            "category": "Critical User Response",
            "metric": "Login Form: Password Provided",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails where the user submitted a non-blank password on a landing-page login form.",
            "id": "8291",
            "campaignid": "11"
        },
        {
            "category": "Critical User Response",
            "metric": "Login Form: User Name Provided",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails where the user submitted a non-blank user name on a landing-page login form.",
            "id": "7661",
            "campaignid": "11"
        },
        {
            "category": "Critical User Response",
            "metric": "Login Form Submitted",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails where the user submitted a login form on the landing page.",
            "id": "7031",
            "campaignid": "11"
        },
        {
            "category": "User Response",
            "metric": "File Download",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails where the user downloaded a file from a landing page.",
            "id": "6401",
            "campaignid": "11"
        },
        {
            "category": "User Response",
            "metric": "Unsubscribe Clicked",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails where the user clicked on an unsubscribe page link.",
            "id": "5771",
            "campaignid": "11"
        },
        {
            "category": "User Response",
            "metric": "Clicked Links",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails where the user clicked on a landing page link or interacted with a smart attachment.",
            "id": "5141",
            "campaignid": "11"
        },
        {
            "category": "User Response",
            "metric": "Image View",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails where the user viewed an embedded image in the email.",
            "id": "4511",
            "campaignid": "11"
        },
        {
            "category": "User Response",
            "metric": "Activity Detected",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails where any type of activity was detected e.g. Clicked Link, Viewed Image, Reply.",
            "id": "3881",
            "campaignid": "11"
        },
        {
            "category": "Outbound",
            "metric": "Undeliverable (Bounced)",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails that were undeliverable because we received a \"bounce\" or Non-Delivery Report\/Receipt.",
            "id": "3251",
            "campaignid": "11"
        },
        {
            "category": "Outbound",
            "metric": "Potential Deliveries",
            "count": "1",
            "opportunity": "1",
            "percent": "100.000",
            "description": "The # of emails that were sent and not rejected by the recipients mail server.",
            "id": "2621",
            "campaignid": "11"
        },
        {
            "category": "Outbound",
            "metric": "Emails Sent",
            "count": "1",
            "opportunity": "1",
            "percent": "100.000",
            "description": "The # of emails sent by PhishLine mail servers.",
            "id": "1281",
            "campaignid": "11"
        },
        {
            "category": "Inbox",
            "metric": "Out of Office",
            "count": "0",
            "opportunity": "1",
            "percent": "0.000",
            "description": "The # of emails where the user sent an automated Out Of Office response.",
            "id": "12071",
            "campaignid": "11"
        }
    ]
}
Success 200
NameTypeDescription
campaignresultstatObject[]

List of campaign result stat / summary data, including: category, metric, count, opportunity, percent, description, id, campaignid.

campaignresultstat.categoryString

The stat category.

campaignresultstat.metricString

The name of this stat.

campaignresultstat.countNumber

The stat count.

campaignresultstat.opportunityNumber

The maximum possible value for count.

campaignresultstat.percentString

Calculated percentage of count vs. opportunity.

campaignresultstat.descriptionString

Longer description of this stat.

campaignresultstat.idNumber

The ID of this metric.

campaignresultstat.campaignidNumber

The associated campaign ID.

Error 4xx
NameTypeDescription
NotAuthorized 

Only authorized users can access this data.

NotFound 

The id of the Campaign was not found.

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": "NotFound",
    "statusDetails": {
        "Reason": "No campaign result stats found for id 113232."
    },
    "entity": "unknown",
    "jobid": 0,
    "notifications": [],
    "data": []
}

 

 

 

Last updated on