Unity API Documentation

GET /service/api/status/reporting/gsm/{gsmKey}/sites
 ?reportType={reportType}
 &effectiveDate={effectiveDate}

Returns a site-level summary report of endpoint usage for a GSM master keycode. For each site the report includes information like the site name and license type as well as the total number of endpoints.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

A master keycode for which usage information is to be retrieved.

 string

Required
reportType

The type of report to be produced. The following values are supported:

  • "ActiveEndpoints": Includes all active devices on the effective report date. Note: If hidden data filter is set within the Webroot console, and if some devices have moved to hidden, the “ActiveEndpoints” will show all hidden as well as non-hidden devices in the total.
  • "ActiveEndpointsWithoutHidden": Includes active devices on the effective report date except for those that were hidden. Note: Reflects the Active Devices total seen within the Webroot console under sites, which filters out any hidden devices. Therefore if hidden devices exist, this device total will be less than “ActiveEndpoints” total.
  • "EndpointsSeenInLast30Days": Includes all devices seen in the last 30 days (between the effective report date and 30 days earlier).
If omitted, the reportType is set to "EndpointsSeenInLast30Days".

 string

None.
effectiveDate

The date the report should refer to. If omitted, the most recent usage report will be returned.

Note: Usage data will typically be generated in the course of the following day (UTC) and therefore can only be provided for dates earlier than yesterday. If, for example, this API method is called at 11:00 pm UTC, yesterday's data will not be available yet.

 date

None.

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/status/reporting/gsm/A9D1-32F8-7DB8-43CB-B503/sites?reportType=ActiveEndpointsWithoutHidden&effectiveDate=2024-04-13T00:00:00.0000000Z

Body Parameters

None.

Response Information

Resource Description

Returns a list of site keycode usage statistics having the specified master key as parent.

UsageReportSites
NameDescriptionTypeAdditional Information
ReportInfo

Details about the returned report.

 UsageReportSites_ReportInfo

None.
Sites

Site/endpoint details for a given GSM site.

 Collection of UsageReportSites_SiteEntry

None.

Sample Response

{
  "ReportInfo": {
    "Count": 2,
    "SiteKeyFilter": null,
    "ReportType": "EndpointsSeenInLast30Days",
    "EffectiveDate": "2024-04-09T00:00:00Z",
    "GSMKey": "lrj9red7sd9sq22n6gz5"
  },
  "Sites": [
    {
      "SiteId": "290dd681-6d02-78e9-12e4-5dce1d984d82",
      "SiteKey": "091yntktl7xwefbg6emh",
      "SiteName": "Site RFONPXHE8E",
      "LicenseType": "Trial",
      "ExpiryDate": "2024-08-11T12:27:46.247454Z",
      "SiteState": "active",
      "SiteStateChangedDate": "2024-03-29T03:43:46.247454Z",
      "TotalEndpoints": 9844
    },
    {
      "SiteId": "0b5963a5-1b9a-6bf0-0b40-1f8839cb41f0",
      "SiteKey": "3ujbjf8lf832tevvoi0m",
      "SiteName": "Site FVHNYJ3M88",
      "LicenseType": "Trial",
      "ExpiryDate": "2025-02-26T22:49:46.247454Z",
      "SiteState": "active",
      "SiteStateChangedDate": "2024-04-09T03:43:46.247454Z",
      "TotalEndpoints": 382
    }
  ]
}                    
<StatusReporting.UsageReportSites xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.AgentStatus.Models">
  <ReportInfo>
    <EffectiveDate>2024-04-09T00:00:00Z</EffectiveDate>
    <GSMKey>lrj9red7sd9sq22n6gz5</GSMKey>
    <ReportType>EndpointsSeenInLast30Days</ReportType>
    <Count>2</Count>
    <SiteKeyFilter i:nil="true" />
  </ReportInfo>
  <Sites>
    <StatusReporting.UsageReportSites_SiteEntry>
      <ExpiryDate>2024-08-11T12:27:46.247454Z</ExpiryDate>
      <LicenseType>Trial</LicenseType>
      <SiteId>290dd681-6d02-78e9-12e4-5dce1d984d82</SiteId>
      <SiteKey>091yntktl7xwefbg6emh</SiteKey>
      <SiteName>Site RFONPXHE8E</SiteName>
      <SiteState>active</SiteState>
      <SiteStateChangedDate>2024-03-29T03:43:46.247454Z</SiteStateChangedDate>
      <TotalEndpoints>9844</TotalEndpoints>
    </StatusReporting.UsageReportSites_SiteEntry>
    <StatusReporting.UsageReportSites_SiteEntry>
      <ExpiryDate>2025-02-26T22:49:46.247454Z</ExpiryDate>
      <LicenseType>Trial</LicenseType>
      <SiteId>0b5963a5-1b9a-6bf0-0b40-1f8839cb41f0</SiteId>
      <SiteKey>3ujbjf8lf832tevvoi0m</SiteKey>
      <SiteName>Site FVHNYJ3M88</SiteName>
      <SiteState>active</SiteState>
      <SiteStateChangedDate>2024-04-09T03:43:46.247454Z</SiteStateChangedDate>
      <TotalEndpoints>382</TotalEndpoints>
    </StatusReporting.UsageReportSites_SiteEntry>
  </Sites>
</StatusReporting.UsageReportSites>