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

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

 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": [],
    "totalRowCount": 0,
    "pageRowCount": 0,
    "remainingRowCount": 0,
    "maxIdReturned": 0,
    "data": []
}
 
HTTP/1.1 404 Not Found
{
    "status": 404,
    "statusMessage": "NotFound",
    "statusDetails": {
        "NotFound": "No web activity found for id 1."
    },
    "entity": "unknown",
    "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": 30
    },
    "totalRowCount": 0,
    "pageRowCount": 0,
    "remainingRowCount": 0,
    "maxIdReturned": 0,
    "data": []
}