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/A1CD-853B-B2C5-4B0E-BF30/sites/3b62d981-bb32-4157-9c92-7c4072612e8f/wsat/campaigns/training/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 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-04-27T10:43:13.6429077Z", "EndDate": "2024-05-27T10:43:13.6429077Z", "Campaigns": [ { "SiteId": "ced2b0fb-8f7f-41d1-b973-117f3414f3e0", "SiteName": "The WSAT Site", "CampaignName": "Campaign Name 1", "LaunchDate": "2024-05-25T10:43:13.6429077Z", "TotalUsers": 2, "TotalComplete": 2, "TargetUsers": [ { "Email": "email1@domain.com", "Complete": true }, { "Email": "email2@domain.com", "Complete": true } ] }, { "SiteId": "ced2b0fb-8f7f-41d1-b973-117f3414f3e0", "SiteName": "The WSAT Site", "CampaignName": "Campaign Name 2", "LaunchDate": "2024-05-23T10:43:13.6429077Z", "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-05-25T10:43:13.6429077Z</LaunchDate> <SiteId>ced2b0fb-8f7f-41d1-b973-117f3414f3e0</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-05-23T10:43:13.6429077Z</LaunchDate> <SiteId>ced2b0fb-8f7f-41d1-b973-117f3414f3e0</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-05-27T10:43:13.6429077Z</EndDate> <StartDate>2024-04-27T10:43:13.6429077Z</StartDate> </GetWSATTrainingActivityResponseModel>