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

Returns a site-level summary report of endpoint usage for a GSM master keycode, filtered by a site keycode. 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

keyCode

The keycode of the site 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) except for those that were deactivated before this period.
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.

Body Parameters

None.

Response Information

Resource Description

Returns site keycode usage statistics for the specified site keycode.

UsageReportSite
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": 1,
    "SiteKeyFilter": null,
    "ReportType": "ActiveEndpointsWithoutHidden",
    "EffectiveDate": "2019-09-03T00:00:00Z",
    "GSMKey": "RTL0-7HQL-F3P9-7B0Z-8A8H"
  },
  "Sites": [
    {
      "SiteId": "12c17f1c-728f-5ead-65d5-0341a3561b66",
      "SiteKey": "5UTU-ICRU-LCBE-B0CQ-AG2N",
      "SiteName": "Site QFUTL495F4",
      "LicenseType": "Trial",
      "ExpiryDate": "2021-02-12T20:12:53.1570316Z",
      "SiteState": "active",
      "SiteStateChangedDate": "2019-09-06T04:49:53.1570316Z",
      "TotalEndpoints": 4058
    }
  ]
}                    
<StatusReporting.UsageReportSite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.AgentStatus.Models">
  <ReportInfo>
    <EffectiveDate>2019-09-03T00:00:00Z</EffectiveDate>
    <GSMKey>RTL0-7HQL-F3P9-7B0Z-8A8H</GSMKey>
    <ReportType>ActiveEndpointsWithoutHidden</ReportType>
    <Count>1</Count>
    <SiteKeyFilter i:nil="true" />
  </ReportInfo>
  <Sites>
    <StatusReporting.UsageReportSites_SiteEntry>
      <ExpiryDate>2021-02-12T20:12:53.1570316Z</ExpiryDate>
      <LicenseType>Trial</LicenseType>
      <SiteId>12c17f1c-728f-5ead-65d5-0341a3561b66</SiteId>
      <SiteKey>5UTU-ICRU-LCBE-B0CQ-AG2N</SiteKey>
      <SiteName>Site QFUTL495F4</SiteName>
      <SiteState>active</SiteState>
      <SiteStateChangedDate>2019-09-06T04:49:53.1570316Z</SiteStateChangedDate>
      <TotalEndpoints>4058</TotalEndpoints>
    </StatusReporting.UsageReportSites_SiteEntry>
  </Sites>
</StatusReporting.UsageReportSite>