GET /service/api/status/reporting/detectionandresponse/gsm/{gsmKey}/sites
?effectiveDate={effectiveDate}
Returns a site-level summary report for "Detection and Response" related products linked to a GSM master keycode. For each site the report includes information like the site name and license type as well as high watermark data.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
gsmKey |
A master keycode for which usage information is to be retrieved. |
string |
Required |
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/detectionandresponse/gsm/7533-70F1-4EA8-4290-844D/sites?effectiveDate=2025-04-14T00:00:00.0000000Z
|
Body Parameters
None.
Response Information
Resource Description
Returns a list of site specific usage statistics for "Detection and Response" related products linked to a GSM master keycode.
UsageReportDetectionAndResponse_SitesName | Description | Type | Additional Information |
---|---|---|---|
ReportInfo |
Details about the returned report. |
UsageReportDetectionAndResponse_ReportInfo |
None. |
General |
General details about the returned report. |
UsageReportDetectionAndResponse_GeneralInfo |
None. |
Sites |
Site details for a given GSM key. |
Collection of UsageReportDetectionAndResponse_SiteData |
None. |
Sample Response
{ "ReportInfo": { "EffectiveDate": "2025-04-04T00:00:00Z", "GSMKey": "wudpajnv2sg7t0dlvuce" }, "General": { "GSMConsoleName": "GSM Console 1", "GSMConsoleLicenseType": "Full" }, "Sites": [ { "SiteName": "Site 1", "SiteLicenseType": "Trial", "SiteKey": "53q927g8pa445rwujq7d", "Products": [ { "ProductName": "Endpoint Detection and Response", "License": { "CreatedDate": "2024-07-13T00:00:00Z", "StartDate": "2024-07-13T00:00:00Z", "EndDate": null, "Status": "Trial", "HighWatermarkEndpoints": 18, "HighWatermarkGigabytes": 0.0 } }, { "ProductName": "Detection and Response Mobile", "License": { "CreatedDate": "2024-07-13T00:00:00Z", "StartDate": "2024-07-13T00:00:00Z", "EndDate": null, "Status": "Trial", "HighWatermarkEndpoints": 18, "HighWatermarkGigabytes": 0.0 } }, { "ProductName": "Detection and Response Chromebook", "License": { "CreatedDate": "2024-07-13T00:00:00Z", "StartDate": "2024-07-13T00:00:00Z", "EndDate": null, "Status": "Trial", "HighWatermarkEndpoints": 18, "HighWatermarkGigabytes": 0.0 } } ] }, { "SiteName": "Site 2", "SiteLicenseType": "Full", "SiteKey": "dvn4edk9atw0tdw3dewd", "Products": [ { "ProductName": "Managed Detection and Response", "License": { "CreatedDate": "2024-07-13T00:00:00Z", "StartDate": "2024-07-13T00:00:00Z", "EndDate": null, "Status": "Full", "HighWatermarkEndpoints": 28, "HighWatermarkGigabytes": 0.0 } }, { "ProductName": "Detection and Response Mobile", "License": { "CreatedDate": "2024-07-13T00:00:00Z", "StartDate": "2024-07-13T00:00:00Z", "EndDate": null, "Status": "Full", "HighWatermarkEndpoints": 36, "HighWatermarkGigabytes": 0.0 } }, { "ProductName": "Detection and Response Chromebook", "License": { "CreatedDate": "2024-07-13T00:00:00Z", "StartDate": "2024-07-13T00:00:00Z", "EndDate": null, "Status": "Full", "HighWatermarkEndpoints": 45, "HighWatermarkGigabytes": 0.0 } }, { "ProductName": "Detection and Response Compliance Storage", "License": { "CreatedDate": "2024-07-13T00:00:00Z", "StartDate": "2024-07-13T00:00:00Z", "EndDate": null, "Status": "Full", "HighWatermarkEndpoints": 0, "HighWatermarkGigabytes": 42.3 } } ] } ] }
<StatusReporting.UsageReportDetectionAndResponse_Sites xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.AgentStatus.Models"> <General> <GSMConsoleLicenseType>Full</GSMConsoleLicenseType> <GSMConsoleName>GSM Console 1</GSMConsoleName> </General> <ReportInfo> <EffectiveDate>2025-04-04T00:00:00Z</EffectiveDate> <GSMKey>wudpajnv2sg7t0dlvuce</GSMKey> </ReportInfo> <Sites> <StatusReporting.UsageReportDetectionAndResponse_SiteData> <Products> <StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site> <License> <HighWatermarkEndpoints>18</HighWatermarkEndpoints> <HighWatermarkGigabytes>0</HighWatermarkGigabytes> <Status>Trial</Status> <CreatedDate>2024-07-13T00:00:00Z</CreatedDate> <EndDate i:nil="true" /> <StartDate>2024-07-13T00:00:00Z</StartDate> </License> <ProductName>Endpoint Detection and Response</ProductName> </StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site> <StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site> <License> <HighWatermarkEndpoints>18</HighWatermarkEndpoints> <HighWatermarkGigabytes>0</HighWatermarkGigabytes> <Status>Trial</Status> <CreatedDate>2024-07-13T00:00:00Z</CreatedDate> <EndDate i:nil="true" /> <StartDate>2024-07-13T00:00:00Z</StartDate> </License> <ProductName>Detection and Response Mobile</ProductName> </StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site> <StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site> <License> <HighWatermarkEndpoints>18</HighWatermarkEndpoints> <HighWatermarkGigabytes>0</HighWatermarkGigabytes> <Status>Trial</Status> <CreatedDate>2024-07-13T00:00:00Z</CreatedDate> <EndDate i:nil="true" /> <StartDate>2024-07-13T00:00:00Z</StartDate> </License> <ProductName>Detection and Response Chromebook</ProductName> </StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site> </Products> <SiteKey>53q927g8pa445rwujq7d</SiteKey> <SiteLicenseType>Trial</SiteLicenseType> <SiteName>Site 1</SiteName> </StatusReporting.UsageReportDetectionAndResponse_SiteData> <StatusReporting.UsageReportDetectionAndResponse_SiteData> <Products> <StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site> <License> <HighWatermarkEndpoints>28</HighWatermarkEndpoints> <HighWatermarkGigabytes>0</HighWatermarkGigabytes> <Status>Full</Status> <CreatedDate>2024-07-13T00:00:00Z</CreatedDate> <EndDate i:nil="true" /> <StartDate>2024-07-13T00:00:00Z</StartDate> </License> <ProductName>Managed Detection and Response</ProductName> </StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site> <StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site> <License> <HighWatermarkEndpoints>36</HighWatermarkEndpoints> <HighWatermarkGigabytes>0</HighWatermarkGigabytes> <Status>Full</Status> <CreatedDate>2024-07-13T00:00:00Z</CreatedDate> <EndDate i:nil="true" /> <StartDate>2024-07-13T00:00:00Z</StartDate> </License> <ProductName>Detection and Response Mobile</ProductName> </StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site> <StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site> <License> <HighWatermarkEndpoints>45</HighWatermarkEndpoints> <HighWatermarkGigabytes>0</HighWatermarkGigabytes> <Status>Full</Status> <CreatedDate>2024-07-13T00:00:00Z</CreatedDate> <EndDate i:nil="true" /> <StartDate>2024-07-13T00:00:00Z</StartDate> </License> <ProductName>Detection and Response Chromebook</ProductName> </StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site> <StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site> <License> <HighWatermarkEndpoints>0</HighWatermarkEndpoints> <HighWatermarkGigabytes>42.3</HighWatermarkGigabytes> <Status>Full</Status> <CreatedDate>2024-07-13T00:00:00Z</CreatedDate> <EndDate i:nil="true" /> <StartDate>2024-07-13T00:00:00Z</StartDate> </License> <ProductName>Detection and Response Compliance Storage</ProductName> </StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site> </Products> <SiteKey>dvn4edk9atw0tdw3dewd</SiteKey> <SiteLicenseType>Full</SiteLicenseType> <SiteName>Site 2</SiteName> </StatusReporting.UsageReportDetectionAndResponse_SiteData> </Sites> </StatusReporting.UsageReportDetectionAndResponse_Sites>