Unity API Documentation

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.

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

NameDescriptionTypeAdditional 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/9ED2-7975-3D99-4B79-890A/sites/027d7f99-5f87-4547-a928-9686804860d0/wsat/campaigns/training/activity?startDate=2020-01-26T07:11:06.2832803Z&endDate=2020-02-25T07:11:06.2832803Z

Body Parameters

None.

Response Information

Resource Description

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

GetWSATTrainingActivityResponseModel
NameDescriptionTypeAdditional 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": "2019-11-25T12:29:08.9085226Z",
  "EndDate": "2019-12-25T12:29:08.9085226Z",
  "Campaigns": [
    {
      "SiteId": "af753a17-10f0-4f7e-98a6-d23a5fca193a",
      "SiteName": "The WSAT Site",
      "CampaignName": "Campaign Name 1",
      "LaunchDate": "2019-12-23T12:29:08.9085226Z",
      "TotalUsers": 2,
      "TotalComplete": 2,
      "TargetUsers": [
        {
          "Email": "email1@domain.com",
          "Complete": true
        },
        {
          "Email": "email2@domain.com",
          "Complete": true
        }
      ]
    },
    {
      "SiteId": "af753a17-10f0-4f7e-98a6-d23a5fca193a",
      "SiteName": "The WSAT Site",
      "CampaignName": "Campaign Name 2",
      "LaunchDate": "2019-12-21T12:29:08.9085226Z",
      "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>2019-12-23T12:29:08.9085226Z</LaunchDate>
      <SiteId>af753a17-10f0-4f7e-98a6-d23a5fca193a</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>2019-12-21T12:29:08.9085226Z</LaunchDate>
      <SiteId>af753a17-10f0-4f7e-98a6-d23a5fca193a</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>2019-12-25T12:29:08.9085226Z</EndDate>
  <StartDate>2019-11-25T12:29:08.9085226Z</StartDate>
</GetWSATTrainingActivityResponseModel>