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.
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/0C85-CE64-B5BA-4380-9DE3/sites/30b1e49a-b7cf-4e04-8f35-7fc138ebc01e/wsat/campaigns/phishing/activity?startDate=2025-08-19T01:53:12.6734325Z&endDate=2025-09-18T01:53:12.6734325Z
|
Body Parameters
None.
Response Information
Resource Description
User activity information within the specified dates for matching phishing campaigns.
GetWSATPhishingActivityResponseModelName | 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": "2025-06-18T10:25:17.4043438Z", "EndDate": "2025-07-18T10:25:17.4043438Z", "Campaigns": [ { "SiteId": "fad383e4-2cb9-4df4-8fe6-5a1cec8116aa", "SiteName": "The WSAT Site", "CampaignName": "Campaign Name 1", "LaunchDate": "2025-07-16T10:25:17.4043438Z", "TotalUsers": 2, "TotalClicked": 2, "TargetUsers": [ { "Email": "email1@domain.com", "Clicked": true }, { "Email": "email2@domain.com", "Clicked": true } ] }, { "SiteId": "fad383e4-2cb9-4df4-8fe6-5a1cec8116aa", "SiteName": "The WSAT Site", "CampaignName": "Campaign Name 2", "LaunchDate": "2025-07-14T10:25:17.4043438Z", "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>2025-07-16T10:25:17.4043438Z</LaunchDate> <SiteId>fad383e4-2cb9-4df4-8fe6-5a1cec8116aa</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>2025-07-14T10:25:17.4043438Z</LaunchDate> <SiteId>fad383e4-2cb9-4df4-8fe6-5a1cec8116aa</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>2025-07-18T10:25:17.4043438Z</EndDate> <StartDate>2025-06-18T10:25:17.4043438Z</StartDate> </GetWSATPhishingActivityResponseModel>