Documentation

GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/wsat/campaigns/phishing/activity
?startDate={startDate}
&endDate={endDate}

Returns information on activity seen for Webroot Security Awareness Training (WSAT) phishing campaigns associated to a given site.

NOTE: The startDate cannot be earlier than one year ago, and the timespan between startDate and endDate must not exceed 90 days.

Request Information

URI Parameters

Name	Description	Type	Additional Information
gsmKey	The GSM console keycode.	string	Required
siteId	The GSM site identifier.	string	Required
startDate	If specified, returns activity information starting from the given date. If omitted, defaults to 'now' minus 30 days.	date	None.
endDate	If specified, returns activity information ending at the given date. If omitted, defaults to 'now'.	date	None.

URI Sample(s)

GET	https://unityapi.webrootcloudav.com/service/api/console/gsm/1B3C-56C6-C412-41C5-BCE1/sites/391f2ad2-714d-4215-8077-5853e2f85c84/wsat/campaigns/phishing/activity?startDate=2024-11-21T02:47:08.0129850Z&endDate=2024-12-21T02:47:08.0129850Z

Body Parameters

None.

Response Information

Resource Description

User activity information within the specified dates for matching phishing campaigns.

GetWSATPhishingActivityResponseModel

Name	Description	Type	Additional Information
CampaignType	The type of the campaign (i.e. Phishing).	string	None.
StartDate	Start date for returned user activity information. Campaign activity after (or at) this date is contained in the response.	date	None.
EndDate	End date for returned user activity information. Campaign activity before (or at) this date is contained in the response.	date	None.
Campaigns	The list of matching campaigns for which activity was seen within the specified dates.	Collection of GetWSATPhishingActivityResponseModel_Campaign	None.

Sample Response

{
  "CampaignType": "Phishing",
  "StartDate": "2024-09-21T10:16:25.3646883Z",
  "EndDate": "2024-10-21T10:16:25.3646883Z",
  "Campaigns": [
    {
      "SiteId": "5fdf6a30-211b-4b51-b27d-cdb8f7210672",
      "SiteName": "The WSAT Site",
      "CampaignName": "Campaign Name 1",
      "LaunchDate": "2024-10-19T10:16:25.3646883Z",
      "TotalUsers": 2,
      "TotalClicked": 2,
      "TargetUsers": [
        {
          "Email": "email1@domain.com",
          "Clicked": true
        },
        {
          "Email": "email2@domain.com",
          "Clicked": true
        }
      ]
    },
    {
      "SiteId": "5fdf6a30-211b-4b51-b27d-cdb8f7210672",
      "SiteName": "The WSAT Site",
      "CampaignName": "Campaign Name 2",
      "LaunchDate": "2024-10-17T10:16:25.3646883Z",
      "TotalUsers": 2,
      "TotalClicked": 2,
      "TargetUsers": [
        {
          "Email": "email2@domain.com",
          "Clicked": true
        },
        {
          "Email": "email4@domain.com",
          "Clicked": true
        }
      ]
    }
  ]
}

<GetWSATPhishingActivityResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models.WSATReporting">
  <CampaignType>Phishing</CampaignType>
  <Campaigns>
    <GetWSATPhishingActivityResponseModel_Campaign>
      <CampaignName>Campaign Name 1</CampaignName>
      <LaunchDate>2024-10-19T10:16:25.3646883Z</LaunchDate>
      <SiteId>5fdf6a30-211b-4b51-b27d-cdb8f7210672</SiteId>
      <SiteName>The WSAT Site</SiteName>
      <TargetUsers>
        <GetWSATPhishingActivityResponseModel_CampaignTargetUser>
          <Clicked>true</Clicked>
          <Email>email1@domain.com</Email>
        </GetWSATPhishingActivityResponseModel_CampaignTargetUser>
        <GetWSATPhishingActivityResponseModel_CampaignTargetUser>
          <Clicked>true</Clicked>
          <Email>email2@domain.com</Email>
        </GetWSATPhishingActivityResponseModel_CampaignTargetUser>
      </TargetUsers>
      <TotalClicked>2</TotalClicked>
      <TotalUsers>2</TotalUsers>
    </GetWSATPhishingActivityResponseModel_Campaign>
    <GetWSATPhishingActivityResponseModel_Campaign>
      <CampaignName>Campaign Name 2</CampaignName>
      <LaunchDate>2024-10-17T10:16:25.3646883Z</LaunchDate>
      <SiteId>5fdf6a30-211b-4b51-b27d-cdb8f7210672</SiteId>
      <SiteName>The WSAT Site</SiteName>
      <TargetUsers>
        <GetWSATPhishingActivityResponseModel_CampaignTargetUser>
          <Clicked>true</Clicked>
          <Email>email2@domain.com</Email>
        </GetWSATPhishingActivityResponseModel_CampaignTargetUser>
        <GetWSATPhishingActivityResponseModel_CampaignTargetUser>
          <Clicked>true</Clicked>
          <Email>email4@domain.com</Email>
        </GetWSATPhishingActivityResponseModel_CampaignTargetUser>
      </TargetUsers>
      <TotalClicked>2</TotalClicked>
      <TotalUsers>2</TotalUsers>
    </GetWSATPhishingActivityResponseModel_Campaign>
  </Campaigns>
  <EndDate>2024-10-21T10:16:25.3646883Z</EndDate>
  <StartDate>2024-09-21T10:16:25.3646883Z</StartDate>
</GetWSATPhishingActivityResponseModel>

GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/wsat/campaigns/phishing/activity ?startDate={startDate} &endDate={endDate}