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

GET {{baseUrl}}/api/status/reporting/gsm/:gsmKey/sites/:keyCode?reportType=EndpointsSeenInLast30Days&effectiveDate=2022-11-24T00:00:00Z

Request Params

KeyDatatypeRequiredDescription
reportTypestringThe 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". | | effectiveDate | string | | 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. |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"ReportInfo":{"Count":1,"SiteKeyFilter":null,"ReportType":"ActiveEndpoints","EffectiveDate":"2022-11-25T00:00:00Z","GSMKey":"fjaojcwo4k5qfs0hhuee"},"Sites":[{"SiteId":"0cf79f1c-0dfd-36aa-7bc5-12dffa393bda","SiteKey":"simlz1cah65judkdnifi","SiteName":"Site T521A1JS6K","LicenseType":"Full","ExpiryDate":"2025-05-19T04:31:02.4191625Z","SiteState":"active","SiteStateChangedDate":"2022-11-03T10:36:02.4191625Z","TotalEndpoints":1152}]}