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/967F-8B88-98D6-4CBB-A397/sites/6231fed4-7f0c-4118-b242-e09c8805db1b/wsat/campaigns/phishing/activity?startDate=2024-06-26T09:36:06.2037746Z&endDate=2024-07-26T09:36:06.2037746Z
|
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": "2024-04-27T10:41:32.2195968Z", "EndDate": "2024-05-27T10:41:32.2195968Z", "Campaigns": [ { "SiteId": "43b64c6d-8aa5-4e5d-8c1a-7ba1689316b1", "SiteName": "The WSAT Site", "CampaignName": "Campaign Name 1", "LaunchDate": "2024-05-25T10:41:32.2195968Z", "TotalUsers": 2, "TotalClicked": 2, "TargetUsers": [ { "Email": "email1@domain.com", "Clicked": true }, { "Email": "email2@domain.com", "Clicked": true } ] }, { "SiteId": "43b64c6d-8aa5-4e5d-8c1a-7ba1689316b1", "SiteName": "The WSAT Site", "CampaignName": "Campaign Name 2", "LaunchDate": "2024-05-23T10:41:32.2195968Z", "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-05-25T10:41:32.2195968Z</LaunchDate> <SiteId>43b64c6d-8aa5-4e5d-8c1a-7ba1689316b1</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-05-23T10:41:32.2195968Z</LaunchDate> <SiteId>43b64c6d-8aa5-4e5d-8c1a-7ba1689316b1</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-05-27T10:41:32.2195968Z</EndDate> <StartDate>2024-04-27T10:41:32.2195968Z</StartDate> </GetWSATPhishingActivityResponseModel>