Outbound Analysis Results

Permission Required to use this API Endpoint

A user with API access must have one of the following permissions:

Email Campaign - Can Edit All
Email Campaign Results - Can View All

For more information, see how to set up a user account with API access.

Get all outbound analysis results

This is all gathered outbound analysis, containing data on what emails were sent out from a campaign.

GET /rest/outboundanalysis/id/afterid?startdate=YYYY-MM-DD&enddate=YYYY-MM-DD

Parameters

Name	Type	Description

Name	Type	Description
id	Integer	Optional. The Campaign ID. No ID, or an ID of "0" (zero), will return all outbound analysis data. If you are using pagination and do not want to use a Campaign ID, you must use a "0". Do not send to /outboundanalysis/afterid, because the afterid would be treated as the Campaign ID.
afterid	Integer	Optional. 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.
startdate	String	Optional. When set, data older than this date is ignored. YYYY-MM-DD format.
enddate	String	Optional. When set, data newer than this date is ignored. YYYY-MM-DD format.
access_token	String	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/outboundanalysis/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/outboundanalysis/11/233091"

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": [],
{
    "status": 200,
    "statusMessage": "OK",
    "statusDetails": [],
    "entity": "outboundanalysis",
    "jobid": 0,
    "notifications": {
        "API Token Expiration Date": "2024-06-20 09:58:27",
        "Maximum API calls per hour": 1000,
        "Your API calls in the last hour": 59
    },
    "totalRowCount": 1459,
    "pageRowCount": 1459,
    "remainingRowCount": 0,
    "maxIdReturned": 26706,
    "data": [
        {
            "id": "19991",
            "messageid": "c84ec6955d8b6ee1e60b407aede929c2",
            "status": "Sent",
            "timezoneActual": "America\/Chicago",
            "timezoneActualSendDate": "2022-01-23 19:54:05",
            "timezoneActualSendAfter": "2022-01-23 19:54:00",
            "timezoneActualDayOfWeek": "1",
            "dayOfWeekText": "Sun",
            "timezoneActualDayOfWeekText": "Sun",
            "subject": "Need your help",
            "to": "exampleuser@barracuda.com",
            "challengeLinkList": "",
            "locked": "1",
            "sent": "1",
            "sending": "0",
            "sendAttempts": "1",
            "sendAfter": "2022-01-23 19:54:00",
            "scheduledTimezoneActual": "2022-01-23 19:54 (Sunday) America\/Chicago UTC-6",
            "sendDate": "2022-01-23 19:54:05",
            "campaignid": "581",
            "campaignName": "Example Campaign Name",
            "campaignType": "Email Campaign",
            "planName": "",
            "planid": "0",
            "campaignCategory": "General",
            "campaignStartDate": "2022-01-23 07:23:00",
            "campaignEndDate": "2022-01-24 07:23:00",
            "campaignCutoffDate": "2022-01-25 07:23:00",
            "campaignIntent": "Testing",
            "campaignLifecycle": "Completed",
            "campaignLocked": "1",
            "campaignModePortableMedia": "0",
            "campaignMediaReportingDate": "0000-00-00 00:00:00",
            "campaignExcludeFromProgramStats": "0",
            "addressBookName": "Book 6 in Group 1",
            "addressBookCategory": "General",
            "emailserverid": "511",
            "emailServerName": "deals@neverclick.net",
            "emailServerType": "Email",
            "emailtemplateid": "1",
            "emailTemplateName": "13 Threats Business Email Compromise",
            "emailTemplateType": "Email",
            "emailTemplateCategory": "Corporate",
            "emailTemplateEnableInlineImages": "0",
            "emailTemplateIsUrgent": "0",
            "webserverid": "141",
            "webServerName": "http:\/\/neverclick.net",
            "webServerType": "Web Server",
            "webServerURL": "http:\/\/neverclick.net\/de1b67fb141",
            "webtemplateid": "1",
            "webTemplateName": "13 Threats Business Email Com",
            "webTemplateType": "Web Page",
            "webTemplateCategory": "Security",
            "webTemplateIVRName": "",
            "addressAddress": "exampleuser@barracuda.com",
            "addressActive": "1",
            "domainAuthValidated": "1",
            "addressAtDomain": "@barracuda.com",
            "addressAnonymized": "0",
            "addressFirstName": "Test",
            "addressLastName": "User",
            "addressFullName": "",
            "addressPersonalTitle": "",
            "addressNameSuffix": "",
            "addressHireDate": "0000-00-00",
            "addressOrgArea": "",
            "addressOrgLevel": "",
            "addressOrgTenure": "",
            "addressCompany": "",
            "addressCountry": "",
            "addressRegion": "",
            "addressSite": "",
            "addressLanguage": "",
            "addressTimeZone": "",
            "addressCity": "",
            "addressState": "",
            "addressZip": "",
            "addressMobile": "",
            "addressOtherMobile": "",
            "addressSource": "",
            "addressManagerEmailAddress": "",
            "addressManagerName": "",
            "addressProgramTermGroup": "",
            "addressProgramTermLevel": "",
            "addressAdhocClickRiskCategory": "",
            "addressAdhocClickCount": "0",
            "addressAdhocClickStartTime": "0000-00-00 00:00:00",
            "addressAdhocClickEndTime": "0000-00-00 00:00:00",
            "addressAdhocClickRunTime": "0000-00-00 00:00:00",
            "addressCustom1": "",
            "addressCustom2": "",
            "addressCustom3": "",
            "addressCustom4": "",
            "addressCustom5": "",
            "addressCustom6": "",
            "addressCustom7": "",
            "addressCustom8": "",
            "addressCustom9": "",
            "addressCustom10": "",
            "addressCustom11": "",
            "addressCustom12": "",
            "addressCustom13": "",
            "addressCustom14": "",
            "addressCustom15": "",
            "addressCustom16": "",
            "addressCustom17": "",
            "addressCustom18": "",
            "addressCustom19": "",
            "addressCustom20": "",
            "addressCustom21": "",
            "addressCustom22": "",
            "addressCustom23": "",
            "addressCustom24": "",
            "addressCustom25": "",
            "addressCustom26": "",
            "addressCustom27": "",
            "addressCustom28": "",
            "addressCustom29": "",
            "addressCustom30": "",
            "addressCustom31": "",
            "addressCustom32": "",
            "addressCustom33": "",
            "addressCustom34": "",
            "addressCustom35": "",
            "addressCustom36": "",
            "addressCustom37": "",
            "addressCustom38": "",
            "addressCustom39": "",
            "addressCustom40": "",
            "addressOffenderCategory": "Non-Offender",
            "addressOffenderFailureNumber": "0",
            "addressOffenderCampaignList": null,
            "addressTraining": "0",
            "addressTrainingPassed": "0",
            "addressTrainingCompleted": "0",
            "addressTotalEventPoints": "7400",
            "undeliverable": "0",
            "outOfOffice": "0",
            "senderAddressVerification": "0",
            "replyReceived": "0",
            "replyOrActivity": "0",
            "activity": "0",
            "activityPageView": "0",
            "activityImageView": "0",
            "activityFileDownload": "0",
            "activityLoginForm": "0",
            "activityUser": "0",
            "oppPw": "0",
            "activityPw": "0",
            "oppLoginCustom": "0",
            "activityLoginCustom": "0",
            "activityFeedbackForm": "0",
            "activityTopic": "0",
            "activitySender": "0",
            "activityMessage": "0",
            "activityFileUpload": "0",
            "activityCaptcha": "0",
            "activityUnsubscribePageView": "0",
            "activityUnsubscribeForm": "0",
            "activityIncidentResponse": "0",
            "activitySmartAttachment": "0",
            "messageType": "Email",
            "clickReporterActionSummary": "No Click and No Report",
            "multiClicker": "0",
            "osList": "N\/A",
            "messageTotalEventPoints": "100",
            "lastSendAttemptError": "",
            "programRollingTermTargetedCount": "91",
            "programRollingTermPageViewCount": "0",
            "programRollingTermReportedCount": "0",
            "programRollingTermPageViewRate": "0.00",
            "programRollingTermReportedRate": "0.00",
            "programRollingTermMultiClicker": "0",
            "programRollingTermConsecutiveClicker": "0",
            "programRollingTermChronicClicker": "0",
            "programRollingTermTrainingList": "",
            "programRollingTermReportingDate": "2022-01-23",
            "programRollingTermReportingTermName": "2022-01",
            "firstSurveyTemplateStarted": "",
            "listSurveyTemplatesStarted": null,
            "timeInSecondsSpentOnPageForOutboundMessage": "0",
            "timeInMinutesSpentOnPageForOutboundMessage": "0.00",
            "minMachineClickTestScore": null,
            "maxMachineClickTestScore": null,
            "firstClickTime": "0000-00-00 00:00:00",
            "firstReportedTime": "0000-00-00 00:00:00",
            "firstClickMinutes": "0",
            "firstReportedMinutes": "0",
            "activityIncidentResponseReporter": "",
            "emailTraining": "0",
            "emailTrainingPassed": "0",
            "emailTrainingCompleted": "0",
            "ivrConfirmationValidated": "0",
            "ivrMaxStepCompleted": "0"
        },
	    DOCUMENTATION NOTE: Additional data truncated for brevity
    ]
}

Success 200

Name	Type	Description

Name	Type	Description
outboundanalysis	Object[]	An outbound analysis record for a single message sent in a campaign.
outboundanalysis.id	bigint	A system assigned unique record identifier.
outboundanalysis.messageid	char	A globaly unique message identifier.
outboundanalysis.status	varchar	The status of the outbound email message.
outboundanalysis.timezoneActual	varchar	The timezone the campaign was scheduled in
outboundanalysis.timezoneActualSendDate	datetime	Send date (converted to actual timezone)
outboundanalysis.timezoneActualSendAfter	datetime	Send after (converted to actual timezone)
outboundanalysis.timezoneActualDayOfWeek	char	Send date day of week number (Sunday=1) (converted to actual timezone)
outboundanalysis.dayOfWeekText	char	Send date day of week converted to short text format
outboundanalysis.timezoneActualDayOfWeekText	char	Send date day of week converted to short text format (converted to actual timezone)
outboundanalysis.subject	varchar	The email message subject.
outboundanalysis.to	varchar	The 'to' address.
outboundanalysis.challengeLinkList	text	List of traning links include in email.
outboundanalysis.locked	tinyint	Is the outbound message locked to prevent delivery attempts?
outboundanalysis.sent	tinyint	Has the outbound message delivery already been attempted without server errors?
outboundanalysis.sending	tinyint	A sent attempt is marked as in-progress right now.
outboundanalysis.sendAttempts	int	The number of send attempts tried so far.
outboundanalysis.sendAfter	datetime	All unlocked, unsent messages will attempt delivery some time after the 'send after' date and time.
outboundanalysis.scheduledTimezoneActual	varchar	The "Send After" date/time in the context of the Schedule Based Upon" setting.
outboundanalysis.sendDate	datetime	The actual date of the last delivery attempt.
outboundanalysis.campaignid	int	The campaign #.
outboundanalysis.campaignName	varchar	The campaign name.
outboundanalysis.campaignType	varchar	The type of campaign.
outboundanalysis.planName	varchar	The plan assigned to the campaign associated with the data.
outboundanalysis.planid	int	The plan # assigned to the campaign associated with the data.
outboundanalysis.campaignCategory	varchar	The campaign category.
outboundanalysis.campaignCategory	varchar	The campaign category.
outboundanalysis.campaignStartDate	datetime	The current campaign start date.
outboundanalysis.campaignEndDate	datetime	The current campaign end date.
outboundanalysis.campaignCutoffDate	datetime	The current campaign cutoff date.
outboundanalysis.campaignIntent	varchar	The objective of the campaign.
outboundanalysis.campaignLifecycle	varchar	The system assigned status of a campaign, used for reporting.
outboundanalysis.campaignLocked	tinyint	Is the campaign locked because it is atleast 30 days past the cutoff date?
outboundanalysis.campaignModePortableMedia	tinyint	Is the campaign a Portable Media Campaign?
outboundanalysis.campaignMediaReportingDate	datetime	The earliest time data will be collected during "Go Live" stage.
outboundanalysis.campaignExcludeFromProgramStats	tinyint	When checked, this activity is excluded from Program Statistics.
outboundanalysis.addressBookName	varchar	The current address book name.
outboundanalysis.addressBookCategory	varchar	The current address book category.
outboundanalysis.emailserverid	int	The email server #
outboundanalysis.emailServerName	varchar	The email server name.
outboundanalysis.emailServerType	varchar	Email Server Type
outboundanalysis.emailtemplateid	int	The email template #.
outboundanalysis.emailTemplateName	varchar	The email template name.
outboundanalysis.emailTemplateType	varchar	Email Template Type
outboundanalysis.emailTemplateCategory	char	The current category in the email template record.
outboundanalysis.emailTemplateEnableInlineImages	tinyint	Are Inline Images enabled in the email template record?
outboundanalysis.emailTemplateIsUrgent	tinyint	Sends the email with highest priority by adding X-Priority=1 to the header.
outboundanalysis.webserverid	int	The web server #.
outboundanalysis.webServerName	char	The current web server name.
outboundanalysis.webServerType	varchar	Web Server Type
outboundanalysis.webServerURL	varchar	The current url in the web server record.
outboundanalysis.webtemplateid	int	The web template #.
outboundanalysis.webTemplateName	char	The current name of the web template record.
outboundanalysis.webTemplateType	varchar	Web Template Type
outboundanalysis.webTemplateCategory	char	The current category of the web template record.
outboundanalysis.webTemplateIVRName	char	Voice Application Name
outboundanalysis.addressAddress	varchar	The current setting of the address in the email address record.
outboundanalysis.addressActive	tinyint	Is the current email address record active?
outboundanalysis.domainAuthValidated	tinyint	Is the domain authorized and validated to receive campaign emails?
outboundanalysis.addressAtDomain	varchar	The domain name used by this email address.
outboundanalysis.addressAnonymized	tinyint	Has the email address record been anonymized?
outboundanalysis.addressFirstName	varchar	The current first name for the email address record.
outboundanalysis.addressLastName	varchar	The current last name in the email address record.
outboundanalysis.addressFullName	varchar	The current full name in the email address record.
outboundanalysis.addressPersonalTitle	varchar	The current personal title in the email address record.
outboundanalysis.addressNameSuffix	varchar	The current name suffix in the email address record.
outboundanalysis.addressHireDate	date	The date the user was hired.
outboundanalysis.addressOrgArea	varchar	The current organization area in the email address record.
outboundanalysis.addressOrgLevel	varchar	The current organization level in the email address record.
outboundanalysis.addressOrgTenure	varchar	The current organization tenure in the email address record.
outboundanalysis.addressCompany	varchar	The company field for the email address associated with the event.
outboundanalysis.addressCountry	varchar	The country field for the email address associated with the event.
outboundanalysis.addressRegion	varchar	The region field for the email address associated with the event.
outboundanalysis.addressSite	varchar	The site field for the email address associated with the event.
outboundanalysis.addressLanguage	varchar	The language field for the email address associated with the event.
outboundanalysis.addressTimeZone	varchar	The timezone field for the email address associated with the event.
outboundanalysis.addressCity	varchar	The city field for the email address associated with the event.
outboundanalysis.addressState	varchar	The state field for the email address associated with the event.
outboundanalysis.addressZip	varchar	The zip code field for the email address associated with the event.
outboundanalysis.addressMobile	varchar	The mobile field for the email address associated with the event.
outboundanalysis.addressOtherMobile	varchar	The phone field for the email address associated with the event.
outboundanalysis.addressSource	varchar	The source field for the email address associated with the event.
outboundanalysis.addressManagerEmailAddress	varchar	The email address of this address book entries Manager or Supervisor.
outboundanalysis.addressManagerName	varchar	The name of this address book entries Manager or Supervisor.
outboundanalysis.addressProgramTermGroup	varchar