GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/wsat/campaigns/training/activity
?startDate={startDate}
&endDate={endDate}
Returns information on activity seen for Webroot Security Awareness Training (WSAT) training 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/C95D-5D89-2299-4D7F-A962/sites/8ff55d1e-c01b-4fe6-8098-7343ee2f549b/wsat/campaigns/training/activity?startDate=2024-11-21T02:13:17.2904509Z&endDate=2024-12-21T02:13:17.2904509Z
|
Body Parameters
None.
Response Information
Resource Description
User activity information within the specified dates for matching training campaigns.
GetWSATTrainingActivityResponseModelName | Description | Type | Additional Information |
---|---|---|---|
CampaignType |
The type of the campaign (i.e. Training). |
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 GetWSATTrainingActivityResponseModel_Campaign |
None. |
Sample Response
{ "CampaignType": "Training", "StartDate": "2024-09-21T16:15:47.6911796Z", "EndDate": "2024-10-21T16:15:47.6911796Z", "Campaigns": [ { "SiteId": "ab417995-a97a-4a56-a4bd-bc6d5847f2f7", "SiteName": "The WSAT Site", "CampaignName": "Campaign Name 1", "LaunchDate": "2024-10-19T16:15:47.6911796Z", "TotalUsers": 2, "TotalComplete": 2, "TargetUsers": [ { "Email": "email1@domain.com", "Complete": true }, { "Email": "email2@domain.com", "Complete": true } ] }, { "SiteId": "ab417995-a97a-4a56-a4bd-bc6d5847f2f7", "SiteName": "The WSAT Site", "CampaignName": "Campaign Name 2", "LaunchDate": "2024-10-17T16:15:47.6911796Z", "TotalUsers": 2, "TotalComplete": 2, "TargetUsers": [ { "Email": "email2@domain.com", "Complete": true }, { "Email": "email4@domain.com", "Complete": true } ] } ] }
<GetWSATTrainingActivityResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models.WSATReporting"> <CampaignType>Training</CampaignType> <Campaigns> <GetWSATTrainingActivityResponseModel_Campaign> <CampaignName>Campaign Name 1</CampaignName> <LaunchDate>2024-10-19T16:15:47.6911796Z</LaunchDate> <SiteId>ab417995-a97a-4a56-a4bd-bc6d5847f2f7</SiteId> <SiteName>The WSAT Site</SiteName> <TargetUsers> <GetWSATTrainingActivityResponseModel_CampaignTargetUser> <Complete>true</Complete> <Email>email1@domain.com</Email> </GetWSATTrainingActivityResponseModel_CampaignTargetUser> <GetWSATTrainingActivityResponseModel_CampaignTargetUser> <Complete>true</Complete> <Email>email2@domain.com</Email> </GetWSATTrainingActivityResponseModel_CampaignTargetUser> </TargetUsers> <TotalComplete>2</TotalComplete> <TotalUsers>2</TotalUsers> </GetWSATTrainingActivityResponseModel_Campaign> <GetWSATTrainingActivityResponseModel_Campaign> <CampaignName>Campaign Name 2</CampaignName> <LaunchDate>2024-10-17T16:15:47.6911796Z</LaunchDate> <SiteId>ab417995-a97a-4a56-a4bd-bc6d5847f2f7</SiteId> <SiteName>The WSAT Site</SiteName> <TargetUsers> <GetWSATTrainingActivityResponseModel_CampaignTargetUser> <Complete>true</Complete> <Email>email2@domain.com</Email> </GetWSATTrainingActivityResponseModel_CampaignTargetUser> <GetWSATTrainingActivityResponseModel_CampaignTargetUser> <Complete>true</Complete> <Email>email4@domain.com</Email> </GetWSATTrainingActivityResponseModel_CampaignTargetUser> </TargetUsers> <TotalComplete>2</TotalComplete> <TotalUsers>2</TotalUsers> </GetWSATTrainingActivityResponseModel_Campaign> </Campaigns> <EndDate>2024-10-21T16:15:47.6911796Z</EndDate> <StartDate>2024-09-21T16:15:47.6911796Z</StartDate> </GetWSATTrainingActivityResponseModel>