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

Returns a GSM-level summary report for "Detection and Response" related products linked to a GSM master keycode. Besides general information like the GSM console name and the product license status the report includes high watermark data.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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/084B-E3E4-C797-4939-BDC3?effectiveDate=2025-04-14T00:00:00.0000000Z

Body Parameters

None.

Response Information

Resource Description

Returns GSM-level usage statistics for "Detection and Response" related products for a GSM keycode.

UsageReportDetectionAndResponse_GSM
NameDescriptionTypeAdditional Information
ReportInfo

Details about the returned report.

 UsageReportDetectionAndResponse_ReportInfo

None.
General

General details about the returned report.

 UsageReportDetectionAndResponse_GeneralInfo

None.
Products

Product details for a given GSM key.

 Collection of UsageReportDetectionAndResponse_ProductEntry

None.

Sample Response

{
  "ReportInfo": {
    "EffectiveDate": "2025-03-31T00:00:00Z",
    "GSMKey": "hu1laamuw4k6kxpnvplc"
  },
  "General": {
    "GSMConsoleName": "GSM WOBDGIA2ID",
    "GSMConsoleLicenseType": "full"
  },
  "Products": [
    {
      "ProductName": "Endpoint Detection and Response",
      "Licenses": [
        {
          "Status": "Full",
          "HighWatermarkEndpoints": 325,
          "HighWatermarkGigabytes": 0.0
        },
        {
          "Status": "Trial",
          "HighWatermarkEndpoints": 218,
          "HighWatermarkGigabytes": 0.0
        }
      ]
    },
    {
      "ProductName": "Managed Detection and Response",
      "Licenses": [
        {
          "Status": "Full",
          "HighWatermarkEndpoints": 25,
          "HighWatermarkGigabytes": 0.0
        },
        {
          "Status": "Trial",
          "HighWatermarkEndpoints": 18,
          "HighWatermarkGigabytes": 0.0
        }
      ]
    },
    {
      "ProductName": "Detection and Response Mobile",
      "Licenses": [
        {
          "Status": "Full",
          "HighWatermarkEndpoints": 15,
          "HighWatermarkGigabytes": 0.0
        },
        {
          "Status": "Trial",
          "HighWatermarkEndpoints": 7,
          "HighWatermarkGigabytes": 0.0
        }
      ]
    },
    {
      "ProductName": "Detection and Response Chromebook",
      "Licenses": [
        {
          "Status": "Full",
          "HighWatermarkEndpoints": 10,
          "HighWatermarkGigabytes": 0.0
        },
        {
          "Status": "Trial",
          "HighWatermarkEndpoints": 12,
          "HighWatermarkGigabytes": 0.0
        }
      ]
    },
    {
      "ProductName": "Detection and Response Compliance Storage",
      "Licenses": [
        {
          "Status": "Full",
          "HighWatermarkEndpoints": 0,
          "HighWatermarkGigabytes": 12.3
        }
      ]
    }
  ]
}                    
<StatusReporting.UsageReportDetectionAndResponse_GSM 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 WOBDGIA2ID</GSMConsoleName>
  </General>
  <Products>
    <StatusReporting.UsageReportDetectionAndResponse_ProductEntry>
      <Licenses>
        <StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
          <HighWatermarkEndpoints>325</HighWatermarkEndpoints>
          <HighWatermarkGigabytes>0</HighWatermarkGigabytes>
          <Status>Full</Status>
        </StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
        <StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
          <HighWatermarkEndpoints>218</HighWatermarkEndpoints>
          <HighWatermarkGigabytes>0</HighWatermarkGigabytes>
          <Status>Trial</Status>
        </StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
      </Licenses>
      <ProductName>Endpoint Detection and Response</ProductName>
    </StatusReporting.UsageReportDetectionAndResponse_ProductEntry>
    <StatusReporting.UsageReportDetectionAndResponse_ProductEntry>
      <Licenses>
        <StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
          <HighWatermarkEndpoints>25</HighWatermarkEndpoints>
          <HighWatermarkGigabytes>0</HighWatermarkGigabytes>
          <Status>Full</Status>
        </StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
        <StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
          <HighWatermarkEndpoints>18</HighWatermarkEndpoints>
          <HighWatermarkGigabytes>0</HighWatermarkGigabytes>
          <Status>Trial</Status>
        </StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
      </Licenses>
      <ProductName>Managed Detection and Response</ProductName>
    </StatusReporting.UsageReportDetectionAndResponse_ProductEntry>
    <StatusReporting.UsageReportDetectionAndResponse_ProductEntry>
      <Licenses>
        <StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
          <HighWatermarkEndpoints>15</HighWatermarkEndpoints>
          <HighWatermarkGigabytes>0</HighWatermarkGigabytes>
          <Status>Full</Status>
        </StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
        <StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
          <HighWatermarkEndpoints>7</HighWatermarkEndpoints>
          <HighWatermarkGigabytes>0</HighWatermarkGigabytes>
          <Status>Trial</Status>
        </StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
      </Licenses>
      <ProductName>Detection and Response Mobile</ProductName>
    </StatusReporting.UsageReportDetectionAndResponse_ProductEntry>
    <StatusReporting.UsageReportDetectionAndResponse_ProductEntry>
      <Licenses>
        <StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
          <HighWatermarkEndpoints>10</HighWatermarkEndpoints>
          <HighWatermarkGigabytes>0</HighWatermarkGigabytes>
          <Status>Full</Status>
        </StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
        <StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
          <HighWatermarkEndpoints>12</HighWatermarkEndpoints>
          <HighWatermarkGigabytes>0</HighWatermarkGigabytes>
          <Status>Trial</Status>
        </StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
      </Licenses>
      <ProductName>Detection and Response Chromebook</ProductName>
    </StatusReporting.UsageReportDetectionAndResponse_ProductEntry>
    <StatusReporting.UsageReportDetectionAndResponse_ProductEntry>
      <Licenses>
        <StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
          <HighWatermarkEndpoints>0</HighWatermarkEndpoints>
          <HighWatermarkGigabytes>12.3</HighWatermarkGigabytes>
          <Status>Full</Status>
        </StatusReporting.UsageReportDetectionAndResponse_LicenseEntry>
      </Licenses>
      <ProductName>Detection and Response Compliance Storage</ProductName>
    </StatusReporting.UsageReportDetectionAndResponse_ProductEntry>
  </Products>
  <ReportInfo>
    <EffectiveDate>2025-03-31T00:00:00Z</EffectiveDate>
    <GSMKey>hu1laamuw4k6kxpnvplc</GSMKey>
  </ReportInfo>
</StatusReporting.UsageReportDetectionAndResponse_GSM>