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

Returns a site-level summary report for "Detection and Response" related products linked to a GSM master keycode by a site keycode. The report includes information like the site name and license type, as well as high watermark data.

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
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/6A25-5920-7864-4FB7-8B18/sites/EF82-AC17-8D7F-4934-B099?effectiveDate=2025-04-14T00:00:00.0000000Z

Body Parameters

None.

Response Information

Resource Description

Returns site specific usage statistics for "Detection and Response" related products linked to a GSM master keycode by a site keycode.

UsageReportDetectionAndResponse_Site
NameDescriptionTypeAdditional Information
ReportInfo

Details about the returned report.

 UsageReportDetectionAndResponse_ReportInfo_Site

None.
General

General details about the returned report.

 UsageReportDetectionAndResponse_GeneralInfo_Site

None.
Products

Details about the returned products in the usage report.

 Collection of UsageReportDetectionAndResponse_ProductEntry_Site

None.

Sample Response

{
  "ReportInfo": {
    "SiteKey": "thch0e6es9o2h7mn2t07",
    "EffectiveDate": "2025-04-03T00:00:00Z",
    "GSMKey": "xtjc2commznr4kvilpn2"
  },
  "General": {
    "SiteName": "Site 1",
    "SiteLicenseType": "Full",
    "GSMConsoleName": "GSM Console 1",
    "GSMConsoleLicenseType": "Full"
  },
  "Products": [
    {
      "ProductName": "Endpoint Detection and Response",
      "License": {
        "CreatedDate": "2024-07-10T00:00:00Z",
        "StartDate": "2024-07-10T00:00:00Z",
        "EndDate": null,
        "Status": "Full",
        "HighWatermarkEndpoints": 20,
        "HighWatermarkGigabytes": 0.0
      }
    },
    {
      "ProductName": "Detection and Response Mobile",
      "License": {
        "CreatedDate": "2024-07-10T00:00:00Z",
        "StartDate": "2024-07-10T00:00:00Z",
        "EndDate": null,
        "Status": "Full",
        "HighWatermarkEndpoints": 15,
        "HighWatermarkGigabytes": 0.0
      }
    },
    {
      "ProductName": "Detection and Response Chromebook",
      "License": {
        "CreatedDate": "2024-07-10T00:00:00Z",
        "StartDate": "2024-07-10T00:00:00Z",
        "EndDate": null,
        "Status": "Full",
        "HighWatermarkEndpoints": 15,
        "HighWatermarkGigabytes": 0.0
      }
    },
    {
      "ProductName": "Detection and Response Compliance Storage",
      "License": {
        "CreatedDate": "2024-07-10T00:00:00Z",
        "StartDate": "2024-07-10T00:00:00Z",
        "EndDate": null,
        "Status": "Full",
        "HighWatermarkEndpoints": 0,
        "HighWatermarkGigabytes": 14.1
      }
    }
  ]
}                    
<StatusReporting.UsageReportDetectionAndResponse_Site 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>
    <SiteLicenseType>Full</SiteLicenseType>
    <SiteName>Site 1</SiteName>
  </General>
  <Products>
    <StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site>
      <License>
        <HighWatermarkEndpoints>20</HighWatermarkEndpoints>
        <HighWatermarkGigabytes>0</HighWatermarkGigabytes>
        <Status>Full</Status>
        <CreatedDate>2024-07-10T00:00:00Z</CreatedDate>
        <EndDate i:nil="true" />
        <StartDate>2024-07-10T00:00:00Z</StartDate>
      </License>
      <ProductName>Endpoint Detection and Response</ProductName>
    </StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site>
    <StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site>
      <License>
        <HighWatermarkEndpoints>15</HighWatermarkEndpoints>
        <HighWatermarkGigabytes>0</HighWatermarkGigabytes>
        <Status>Full</Status>
        <CreatedDate>2024-07-10T00:00:00Z</CreatedDate>
        <EndDate i:nil="true" />
        <StartDate>2024-07-10T00:00:00Z</StartDate>
      </License>
      <ProductName>Detection and Response Mobile</ProductName>
    </StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site>
    <StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site>
      <License>
        <HighWatermarkEndpoints>15</HighWatermarkEndpoints>
        <HighWatermarkGigabytes>0</HighWatermarkGigabytes>
        <Status>Full</Status>
        <CreatedDate>2024-07-10T00:00:00Z</CreatedDate>
        <EndDate i:nil="true" />
        <StartDate>2024-07-10T00:00:00Z</StartDate>
      </License>
      <ProductName>Detection and Response Chromebook</ProductName>
    </StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site>
    <StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site>
      <License>
        <HighWatermarkEndpoints>0</HighWatermarkEndpoints>
        <HighWatermarkGigabytes>14.1</HighWatermarkGigabytes>
        <Status>Full</Status>
        <CreatedDate>2024-07-10T00:00:00Z</CreatedDate>
        <EndDate i:nil="true" />
        <StartDate>2024-07-10T00:00:00Z</StartDate>
      </License>
      <ProductName>Detection and Response Compliance Storage</ProductName>
    </StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Site>
  </Products>
  <ReportInfo>
    <EffectiveDate>2025-04-03T00:00:00Z</EffectiveDate>
    <GSMKey>xtjc2commznr4kvilpn2</GSMKey>
    <SiteKey>thch0e6es9o2h7mn2t07</SiteKey>
  </ReportInfo>
</StatusReporting.UsageReportDetectionAndResponse_Site>