Web Activity
Permission Required to use this API Endpoint
One of the following permissions is required:
Email Campaign – Can Edit All
Email Campaign Results – Can View All
Get all web activity results
This is all gathered web activity, containing data on which users clicked or otherwise interacted with the phishing exercise.
GET /rest/webactivity/id/afterid?startdate=YYYY-MM-DD&enddate=YYYY-MM-DD
Parameters
Name | Type | Description |
|---|---|---|
id | Integer | Optional. The Campaign ID. No ID, or an ID of "0" (zero), will return all web activity data. If you are using pagination and do not want to use a Campaign ID, you must use a "0". |
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/webactivity/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/webactivity/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": [],
"entity": "webactivity",
"jobid": 0,
"notifications": {
"API Token Expiration Date": "2022-09-23 12:13:13",
"Maximum API calls per hour": 1000,
"Your API calls in the last hour": 27
},
"totalRowCount": 87,
"pageRowCount": 87,
"remainingRowCount": 0,
"maxIdReturned": 32251,
"data": [
{
"outboundid": "3051",
"actionType": "Click",
"actionPageView": "1",
"actionImageView": "0",
"actionFileDownload": "0",
"actionLoginForm": "0",
"actionLoginAuthorized": "0",
"actionUser": "0",
"actionUserValue": "N\/A",
"actionPw": "0",
"actionLoginCustom": "0",
"actionLoginCustomValue": "",
"actionFeedbackForm": "0",
"actionTopic": "0",
"actionSender": "0",
"actionMessage": "0",
"actionFileUpload": "0",
"actionFileUploadName": "N\/A",
"actionCaptcha": "0",
"actionCaptchaAuthorized": "0",
"actionUnsubscribePageView": "0",
"actionUnsubscribeForm": "0",
"actionUnsubscribeFormValue": "N\/A",
"actionSmartAttachment": "0",
"actionSmartAttachmentType": "N\/A",
"os": "Mac OS",
"httpUserAgent": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10.11; rv:47.0) Gecko\/20100101 Firefox\/47.0",
"httpReferer": "N\/A",
"remoteAddr": "192.168.1.10",
"clientIPAddr": "N\/A",
"clientPCName": "N\/A",
"clientUserName": "N\/A",
"clientAdmin": "0",
"pageViewElapsedTimeInSeconds": "10",
"remoteAddrHostName": "Host 10.1.168.192.in-addr.arpa not found: 3(NXDOMAIN)",
"remoteAddrOrganization": "N\/A",
"remoteAddrCountryName": "N\/A",
"remoteAddrStateCode": "N\/",
"remoteAddrStateName": "N\/A",
"remoteAddrCityName": "N\/A",
"remoteAddrLatitude": "0.000000",
"remoteAddrLongitude": "0.000000",
"remoteAddrISPName": "NA",
"remoteAddrNetSpeed": "NA",
"remoteAddrUserType": "NA",
"remoteAddrAccuracyRadiusKM": "0",
"serverName": "neverclick.net",
"requestMethod": "GET",
"requestURI": "\/de44001f141\/3b31046e21e0d61f38331f84\/index.php?id=dc50f8cf4d50",
"requestTime": "2021-07-22 08:50:23",
"requestTimeZoneActual": "2021-07-22 08:50:23",
"requestTimeZoneActualText": "2021-07-22 08:50:23 (Friday) America/Chicago UTC-6",
"requestDate": "0000-00-00",
"navigatorVersion": "N\/A",
"navigatorCookieEnabled": "0",
"navigatorPlatform": "N\/A",
"navigatorUserAgent": "N\/A",
"navigatorJavaEnabled": "N\/A",
"navigatorTaintEnabled": "N\/A",
"navigatorGeolocationAccuracy": "N\/A",
"navigatorGeolocationError": "N\/A",
"engineWebKit": "N\/A",
"campaignName": "Iframe test campaign (cnn.com)",
"planName": "Assessing current user abilities",
"planid": "1",
"campaignCategory": "General",
"campaignStartDate": "2021-07-22 08:43:00",
"campaignEndDate": "2021-07-23 08:43:00",
"campaignCutoffDate": "2021-07-24 08:43:00",
"campaignModePortableMedia": "0",
"campaignMediaReportingDate": "0000-00-00 00:00:00",
"addressBookName": "N\/A",
"addressBookCategory": "N\/A",
"emailServerName": "neverclick.net - advisor",
"emailTemplateName": "Background Check",
"emailTemplateCategory": "Legal",
"webServerName": "http:\/\/neverclick.net",
"webTemplateName": "testing-Iframe",
"webTemplateCategory": "General",
"outboundSubject": "Background check requested",
"outboundTo": "ryan.stone@phishline.com",
"outboundReplyTo": "\"Privacy Notifier\" <advisor@neverclick.net>",
"outboundSender": "\"Privacy Notifier\" <advisor@neverclick.net>",
"outboundSendDate": "2021-07-22 08:49:14",
"outboundUndeliverable": "0",
"outboundOutOfOffice": "0",
"outboundReplyReceived": "0",
"outboundActivityPageView": "1",
"addressAddress": "ryan.stone@phishline.com",
"addressActive": "1",
"addressAtRestricted": "0",
"addressAtDomain": "@phishline.com",
"addressAnonymized": "0",
"addressFirstName": "SampleFirstName",
"addressLastName": "SampleLastName",
"addressFullName": "SampleFullName",
"addressPersonalTitle": "SamplePersonalTitle",
"addressNameSuffix": "SampleNameSuffix",
"addressOrgArea": "N\/A",
"addressOrgLevel": "N\/A",
"addressOrgTenure": "N\/A",
"addressCompany": "N\/A",
"addressCountry": "N\/A",
"addressRegion": "N\/A",
"addressSite": "N\/A",
"addressLanguage": "N\/A",
"addressTimeZone": "N\/A",
"addressCity": "",
"addressState": "N\/A",
"addressZip": "",
"addressSource": "N\/A",
"addressManagerEmailAddress": "",
"addressManagerName": "",
"addressProgramTermGroup": "",
"addressProgramTermLevel": "",
"addressCustom1": "N\/A",
"addressCustom2": "N\/A",
"addressCustom3": "N\/A",
"addressCustom4": "N\/A",
"addressCustom5": "N\/A",
"addressCustom6": "N\/A",
"addressCustom7": "N\/A",
"addressCustom8": "N\/A",
"addressCustom9": "N\/A",
"addressCustom10": "N\/A",
"addressCustom11": "N\/A",
"addressCustom12": "N\/A",
"addressCustom13": "N\/A",
"addressCustom14": "N\/A",
"addressCustom15": "N\/A",
"addressCustom16": "N\/A",
"addressCustom17": "N\/A",
"addressCustom18": "N\/A",
"addressCustom19": "N\/A",
"addressCustom20": "N\/A",
"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",
"addressTraining": "0",
"addressTrainingPassed": "0",
"addressTrainingCompleted": "0",
"emailTraining": "0",
"emailTrainingPassed": "0",
"emailTrainingCompleted": "0",
"id": "9031",
"campaignid": "241"
},
{
"outboundid": "3111",
"actionType": "Click",
"actionPageView": "1",
"actionImageView": "0",
"actionFileDownload": "0",
"actionLoginForm": "0",
"actionLoginAuthorized": "0",
"actionUser": "0",
"actionUserValue": "N\/A",
"actionPw": "0",
"actionLoginCustom": "0",
"actionLoginCustomValue": "",
"actionFeedbackForm": "0",
"actionTopic": "0",
"actionSender": "0",
"actionMessage": "0",
"actionFileUpload": "0",
"actionFileUploadName": "N\/A",
"actionCaptcha": "0",
"actionCaptchaAuthorized": "0",
"actionUnsubscribePageView": "0",
"actionUnsubscribeForm": "0",
"actionUnsubscribeFormValue": "N\/A",
"actionSmartAttachment": "0",
"actionSmartAttachmentType": "N\/A",
"os": "Mac OS",
"httpUserAgent": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10.11; rv:47.0) Gecko\/20100101 Firefox\/47.0",
"httpReferer": "N\/A",
"remoteAddr": "192.168.1.10",
"clientIPAddr": "N\/A",
"clientPCName": "N\/A",
"clientUserName": "N\/A",
"clientAdmin": "0",
"pageViewElapsedTimeInSeconds": "139",
"remoteAddrHostName": "Host 10.1.168.192.in-addr.arpa not found: 3(NXDOMAIN)",
"remoteAddrOrganization": "N\/A",
"remoteAddrCountryName": "N\/A",
"remoteAddrStateCode": "N\/",
"remoteAddrStateName": "N\/A",
"remoteAddrCityName": "N\/A",
"remoteAddrLatitude": "0.000000",
"remoteAddrLongitude": "0.000000",
"remoteAddrISPName": "NA",
"remoteAddrNetSpeed": "NA",
"remoteAddrUserType": "NA",
"remoteAddrAccuracyRadiusKM": "0",
"serverName": "neverclick.net",
"requestMethod": "GET",
"requestURI": "\/de44001f141\/3b31046e21e0d61f38331f84\/index.php?id=9243c703b393b",
"requestTime": "2021-07-22 08:59:23",
"requestTimeZoneActual": "2021-07-22 08:59:23",
"requestTimeZoneActualText": "2021-07-22 08:59:23 (Friday) America/Chicago UTC-6",
"requestDate": "0000-00-00",
"navigatorVersion": "N\/A",
"navigatorCookieEnabled": "0",
"navigatorPlatform": "N\/A",
"navigatorUserAgent": "N\/A",
"navigatorJavaEnabled": "N\/A",
"navigatorTaintEnabled": "N\/A",
"navigatorGeolocationAccuracy": "N\/A",
"navigatorGeolocationError": "N\/A",
"engineWebKit": "N\/A",
"campaignName": "iframe test campaign (firstmidwest.com)",
"planName": "Assessing current user abilities",
"planid": "1",
"campaignCategory": "General",
"campaignStartDate": "2021-07-22 08:56:00",
"campaignEndDate": "2021-07-23 08:56:00",
"campaignCutoffDate": "2021-07-24 08:56:00",
"campaignModePortableMedia": "0",
"campaignMediaReportingDate": "0000-00-00 00:00:00",
"addressBookName": "N\/A",
"addressBookCategory": "N\/A",
"emailServerName": "neverclick.net - noreply",
"emailTemplateName": "Online Bank Security Notice",
"emailTemplateCategory": "Financial",
"webServerName": "http:\/\/neverclick.net",
"webTemplateName": "testing-Iframe",
"webTemplateCategory": "General",
"outboundSubject": "Online Security Notification ",
"outboundTo": "ryan.stone@phishline.com",
"outboundReplyTo": "\"Security\" <noreply@neverclick.net>",
"outboundSender": "\"Security\" <noreply@neverclick.net>",
"outboundSendDate": "2021-07-22 08:58:49",
"outboundUndeliverable": "0",
"outboundOutOfOffice": "0",
"outboundReplyReceived": "0",
"outboundActivityPageView": "1",
"addressAddress": "ryan.stone@phishline.com",
"addressActive": "1",
"addressAtRestricted": "0",
"addressAtDomain": "@phishline.com",
"addressAnonymized": "0",
"addressFirstName": "SampleFirstName",
"addressLastName": "SampleLastName",
"addressFullName": "SampleFullName",
"addressPersonalTitle": "SamplePersonalTitle",
"addressNameSuffix": "SampleNameSuffix",
"addressOrgArea": "N\/A",
"addressOrgLevel": "N\/A",
"addressOrgTenure": "N\/A",
"addressCompany": "N\/A",
"addressCountry": "N\/A",
"addressRegion": "N\/A",
"addressSite": "N\/A",
"addressLanguage": "N\/A",
"addressTimeZone": "N\/A",
"addressCity": "",
"addressState": "N\/A",
"addressZip": "",
"addressSource": "N\/A",
"addressManagerEmailAddress": "",
"addressManagerName": "",
"addressProgramTermGroup": "",
"addressProgramTermLevel": "",
"addressCustom1": "N\/A",
"addressCustom2": "N\/A",
"addressCustom3": "N\/A",
"addressCustom4": "N\/A",
"addressCustom5": "N\/A",
"addressCustom6": "N\/A",
"addressCustom7": "N\/A",
"addressCustom8": "N\/A",
"addressCustom9": "N\/A",
"addressCustom10": "N\/A",
"addressCustom11": "N\/A",
"addressCustom12": "N\/A",
"addressCustom13": "N\/A",
"addressCustom14": "N\/A",
"addressCustom15": "N\/A",
"addressCustom16": "N\/A",
"addressCustom17": "N\/A",
"addressCustom18": "N\/A",
"addressCustom19": "N\/A",
"addressCustom20": "N\/A",
"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",
"addressTraining": "0",
"addressTrainingPassed": "0",
"addressTrainingCompleted": "0",
"emailTraining": "0",
"emailTrainingPassed": "0",
"emailTrainingCompleted": "0",
"id": "9061",
"campaignid": "251"
},
{
"outboundid": "3121",
"actionType": "Click",
DOCUMENTATION NOTE: Additional data truncated for brevity
}
]
}Success 200
Name | Type | Description |
|---|---|---|
webactivity | Object[] | A web activity record for a single email address / campaign combination. |
webactivity.outboundid | Number | The outbound record id. |
webactivity.actionType | String | A summary description of the web activity. If a single activity falls in multiple types, the system assigns to most specific. |
webactivity.actionPageView | Boolean | Clicked on a link. |
webactivity.actionImageView | Boolean | Performed an action image view. |
webactivity.actionFileDownload | Boolean | Performed an action file download. |
webactivity.actionLoginForm | Boolean | Submitted a login form. |
webactivity.actionLoginAuthorized | Boolean | Submitted a login form with both a user and password. |
webactivity.actionUser | Boolean | Submitted a user field on a login form. |
webactivity.actionUserValue | String | User value submitted on the login form. Blank or "N/A" indicated the user did not enter a value. |
webactivity.actionPw | Boolean | Submitted a password on a login form. |
webactivity.actionLoginCustom | Boolean | A value was entered in the login form text field. |
webactivity.actionLoginCustomValue | String | The value entered in the login form text field. |
webactivity.actionFeedbackForm | Boolean | Submitted a feedback form. |
webactivity.actionTopic | Boolean |
|
webactivity.actionSender | Boolean |
|
webactivity.actionMessage | Boolean |
|
webactivity.actionFileUpload | Boolean | Uploaded a file to a form. |
webactivity.actionFileUploadName | String | user value submitted in a file upload. |
webactivity.actionCaptcha | Boolean | Submitted an image captcha form. |
webactivity.actionCaptchaAuthorized | Boolean | Submitted a non-blank response on a captcha field. |
webactivity.actionUnsubscribePageView | Boolean | Clicked an unsubscribe page. |
webactivity.actionUnsubscribeForm | Boolean | Submitted an unsubscribe form. |
webactivity.actionUnsubscribeFormValue | String | The value submitted in an unsubscribe form. |
webactivity.actionSmartAttachment | Boolean | Performed a smart attachment open or link click. |
webactivity.actionSmartAttachmentType | String | If available, the type of smart attachment that was initiated to get to the landing page. |
webactivity.os | String | The operating system as reported by the browser. |
webactivity.httpUserAgent | String | The HTTP user agent as reported by the browser. |
webactivity.httpReferer | String | The HTTP referer as reported by the browser. |
webactivity.remoteAddr | String | The remote address as reported by the browser. |
webactivity.clientIPAddr | String | The IP address of the client machine. |
webactivity.clientPCName | String | The name of the client machine. |
webactivity.clientUserName | String | The user name logged into the client machine. |
webactivity.clientAdmin | Boolean | The client PC user has administrator rights. |
webactivity.pageViewElapsedTimeInSeconds | Number | The total number of seconds this page was detected as being open in the browser, only applies when activity is for Page View. |
webactivity.remoteAddrHostName | String | The DNS host name derived from the users IP address. |
webactivity.remoteAddrOrganization | String | The organization name derived from the user's IP address. |
webactivity.remoteAddrCountryName | String | The country name derived from the users IP address. |
webactivity.remoteAddrStateCode | String | The state code associated with this IP address. |
webactivity.remoteAddrStateName | String | The state/region name associated with the IP address. |
webactivity.remoteAddrCityName | String | The city name associated with the IP address. |
webactivity.remoteAddrLatitude | String | The latitude associated with the IP address. This is NOT from the user's GPS – it is likely from the ISP. |
webactivity.remoteAddrLongitude | String | The longitude associated with the IP address. This is NOT from the user's GPS – it is likely from the ISP. |
webactivity.remoteAddrISPName | String | The Internet Service Provider (ISP) associated with the IP address. |
webactivity.remoteAddrNetSpeed | String | The network type reported based on the IP address. |
webactivity.remoteAddrUserType | String | The user type based on the IP address. |
webactivity.remoteAddrAccuracyRadiusKM | Number | The approximate accuracy for the IP address latitude/longitude. This is NOT from the users GPS – it represents the ISP. |
webactivity.serverName | String | The server name. |
webactivity.requestMethod | String | The request method. |
webactivity.requestURI | String | The request URI. |
webactivity.requestTime | Date | The request date and time. |
webactivity.requestTimeZoneActual | DateTime | The date/time of the request (converted to actual timezone). |
webactivity.requestTimeZoneActualText | String | The date/time of the request (with full actual timezone text). |
webactivity.requestDate | Date | The request date. |
webactivity.navigatorVersion | String |
|
webactivity.navigatorCookieEnabled | String |
|
webactivity.navigatorPlatform | String |
|
webactivity.navigatorUserAgent | String |
|
webactivity.navigatorJavaEnabled | String |
|
webactivity.navigatorTaintEnabled | String |
|
webactivity.navigatorGeolocationAccuracy | String |
|
webactivity.navigatorGeolocationError | String |
|
webactivity.engineWebKit | String |
|
webactivity.campaignName | String | The campaign name. |
webactivity.planName | String | The plan assigned to the campaign associated with the data. |
webactivity.planid | Number | The plan # assigned to the campaign associated with the data. |
webactivity.campaignCategory | String | The campaign category. |
webactivity.campaignStartDate | Date | The current campaign start date. |
webactivity.campaignEndDate | Date | The current campaign end date. |
webactivity.campaignCutoffDate | Date | The current campaign cutoff date. |
webactivity.campaignModePortableMedia | Date | Is the campaign a Portable Media Campaign? |
webactivity.campaignMediaReportingDate | Date | The media reporting date for portable media campaigns only. |
webactivity.addressBookName | String | The current address book name. |
webactivity.addressBookCategory | String | The current address book category. |
webactivity.emailServerName | String | The email server name. |
webactivity.emailTemplateName | String | The email template name. |
webactivity.emailTemplateCategory | String | The current category in the email template record. |
webactivity.webServerName | String | The current web server name. |
webactivity.webTemplateName | String | The current name of the web template record. |
webactivity.webTemplateCategory | String | The current category of the web template record. |
webactivity.outboundSubject | String | The "Subject" of the corresponding Outbound Message. |
webactivity.outboundTo | String | The "To" in the corresponding Outbound Message. |
webactivity.outboundReplyTo | String | The "Reply To" in the corresponding Outbound Message. |
webactivity.outboundSender | String | The "Sender" for the corresponding Outbound Message. |
webactivity.outboundSendDate | String | The send date of the corresponding outbound message. |
Contact Us
Barracuda Campus
Barracuda Support