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

Returns an endpoint-level summary report for "Detection and Response" related products linked to a GSM master keycode by a site keycode. For each endpoint the report includes information like the endpoint's agent id, hostname, mac address and its host ip 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.
continuation

The continuation token for batched requests.

 string

None.

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/status/reporting/detectionandresponse/gsm/D323-66AF-1470-4E29-9C53/sites/5064-52C5-047C-490C-932B/endpoints?effectiveDate=2025-04-14T00:00:00.0000000Z&continuation=lZXEdKGAQQtJpLzo

Body Parameters

None.

Response Information

Resource Description

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

UsageReportDetectionAndResponse_Endpoint
NameDescriptionTypeAdditional Information
ReportInfo

Details about the returned report.

 UsageReportDetectionAndResponse_ReportInfo_Endpoint

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_Endpoint

None.

Sample Response

{
  "ReportInfo": {
    "ContinuationToken": "DgUGorLQbZ4k7M2f",
    "SiteKey": "wbdjaj9a5rgsy4f8d2pc",
    "EffectiveDate": "2025-04-06T00:00:00Z",
    "GSMKey": "csbfibq5fu7uanm4zvkf"
  },
  "General": {
    "SiteName": "Site 1",
    "SiteLicenseType": "Full",
    "GSMConsoleName": "GSM Console 1",
    "GSMConsoleLicenseType": "Full"
  },
  "Products": [
    {
      "ProductName": "Endpoint Detection and Response",
      "Endpoints": [
        {
          "AgentId": "123456789012345678901240",
          "HostName": "Host Name 11",
          "MacAddress": "03:1A:2B:3C:4D:5J",
          "HostIP": "192.168.0.11",
          "MobileNumber": null,
          "Heartbeat": "2024-10-08T16:17:52Z"
        },
        {
          "AgentId": "123456789012345678901241",
          "HostName": "Host Name 12",
          "MacAddress": "04:1A:2B:3C:4D:5K",
          "HostIP": "192.168.0.12",
          "MobileNumber": null,
          "Heartbeat": "2024-10-10T16:17:52Z"
        },
        {
          "AgentId": "123456789012345678901244",
          "HostName": "Host Name 13",
          "MacAddress": "05:1A:2B:3C:4D:5L",
          "HostIP": "192.168.1.12",
          "MobileNumber": null,
          "Heartbeat": "2024-10-11T16:17:52Z"
        }
      ]
    },
    {
      "ProductName": "Detection and Response Mobile",
      "Endpoints": [
        {
          "AgentId": "123456789012345678901247",
          "HostName": "Host Name 17",
          "MacAddress": null,
          "HostIP": "192.168.0.14",
          "MobileNumber": "......1234",
          "Heartbeat": "2024-10-08T16:17:52Z"
        },
        {
          "AgentId": "123456789012345678901248",
          "HostName": "Host Name 18",
          "MacAddress": null,
          "HostIP": "192.168.0.15",
          "MobileNumber": "......2345",
          "Heartbeat": "2024-10-10T16:17:52Z"
        },
        {
          "AgentId": "123456789012345678901249",
          "HostName": "Host Name 19",
          "MacAddress": null,
          "HostIP": "192.168.1.16",
          "MobileNumber": "......3456",
          "Heartbeat": "2024-10-11T16:17:52Z"
        }
      ]
    },
    {
      "ProductName": "Detection and Response Chromebook",
      "Endpoints": [
        {
          "AgentId": "123456789012345678901250",
          "HostName": "Host Name 20",
          "MacAddress": "03:1A:2B:3C:4D:5S",
          "HostIP": "192.168.0.14",
          "MobileNumber": null,
          "Heartbeat": "2024-10-08T16:17:52Z"
        },
        {
          "AgentId": "123456789012345678901251",
          "HostName": "Host Name 21",
          "MacAddress": "04:1A:2B:3C:4D:5T",
          "HostIP": "192.168.0.15",
          "MobileNumber": null,
          "Heartbeat": "2024-10-10T16:17:52Z"
        },
        {
          "AgentId": "123456789012345678901252",
          "HostName": "Host Name 22",
          "MacAddress": "05:1A:2B:3C:4D:5U",
          "HostIP": "192.168.1.16",
          "MobileNumber": null,
          "Heartbeat": "2024-10-11T16:17:52Z"
        }
      ]
    }
  ]
}                    
<StatusReporting.UsageReportDetectionAndResponse_Endpoint 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_Endpoint>
      <Endpoints>
        <StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
          <AgentId>123456789012345678901240</AgentId>
          <Heartbeat>2024-10-08T16:17:52Z</Heartbeat>
          <HostIP>192.168.0.11</HostIP>
          <HostName>Host Name 11</HostName>
          <MacAddress>03:1A:2B:3C:4D:5J</MacAddress>
          <MobileNumber i:nil="true" />
        </StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
        <StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
          <AgentId>123456789012345678901241</AgentId>
          <Heartbeat>2024-10-10T16:17:52Z</Heartbeat>
          <HostIP>192.168.0.12</HostIP>
          <HostName>Host Name 12</HostName>
          <MacAddress>04:1A:2B:3C:4D:5K</MacAddress>
          <MobileNumber i:nil="true" />
        </StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
        <StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
          <AgentId>123456789012345678901244</AgentId>
          <Heartbeat>2024-10-11T16:17:52Z</Heartbeat>
          <HostIP>192.168.1.12</HostIP>
          <HostName>Host Name 13</HostName>
          <MacAddress>05:1A:2B:3C:4D:5L</MacAddress>
          <MobileNumber i:nil="true" />
        </StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
      </Endpoints>
      <ProductName>Endpoint Detection and Response</ProductName>
    </StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Endpoint>
    <StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Endpoint>
      <Endpoints>
        <StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
          <AgentId>123456789012345678901247</AgentId>
          <Heartbeat>2024-10-08T16:17:52Z</Heartbeat>
          <HostIP>192.168.0.14</HostIP>
          <HostName>Host Name 17</HostName>
          <MacAddress i:nil="true" />
          <MobileNumber>......1234</MobileNumber>
        </StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
        <StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
          <AgentId>123456789012345678901248</AgentId>
          <Heartbeat>2024-10-10T16:17:52Z</Heartbeat>
          <HostIP>192.168.0.15</HostIP>
          <HostName>Host Name 18</HostName>
          <MacAddress i:nil="true" />
          <MobileNumber>......2345</MobileNumber>
        </StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
        <StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
          <AgentId>123456789012345678901249</AgentId>
          <Heartbeat>2024-10-11T16:17:52Z</Heartbeat>
          <HostIP>192.168.1.16</HostIP>
          <HostName>Host Name 19</HostName>
          <MacAddress i:nil="true" />
          <MobileNumber>......3456</MobileNumber>
        </StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
      </Endpoints>
      <ProductName>Detection and Response Mobile</ProductName>
    </StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Endpoint>
    <StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Endpoint>
      <Endpoints>
        <StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
          <AgentId>123456789012345678901250</AgentId>
          <Heartbeat>2024-10-08T16:17:52Z</Heartbeat>
          <HostIP>192.168.0.14</HostIP>
          <HostName>Host Name 20</HostName>
          <MacAddress>03:1A:2B:3C:4D:5S</MacAddress>
          <MobileNumber i:nil="true" />
        </StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
        <StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
          <AgentId>123456789012345678901251</AgentId>
          <Heartbeat>2024-10-10T16:17:52Z</Heartbeat>
          <HostIP>192.168.0.15</HostIP>
          <HostName>Host Name 21</HostName>
          <MacAddress>04:1A:2B:3C:4D:5T</MacAddress>
          <MobileNumber i:nil="true" />
        </StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
        <StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
          <AgentId>123456789012345678901252</AgentId>
          <Heartbeat>2024-10-11T16:17:52Z</Heartbeat>
          <HostIP>192.168.1.16</HostIP>
          <HostName>Host Name 22</HostName>
          <MacAddress>05:1A:2B:3C:4D:5U</MacAddress>
          <MobileNumber i:nil="true" />
        </StatusReporting.UsageReportDetectionAndResponse_EndpointEntry>
      </Endpoints>
      <ProductName>Detection and Response Chromebook</ProductName>
    </StatusReporting.UsageReportDetectionAndResponse_ProductEntry_Endpoint>
  </Products>
  <ReportInfo>
    <EffectiveDate>2025-04-06T00:00:00Z</EffectiveDate>
    <GSMKey>csbfibq5fu7uanm4zvkf</GSMKey>
    <SiteKey>wbdjaj9a5rgsy4f8d2pc</SiteKey>
    <ContinuationToken>DgUGorLQbZ4k7M2f</ContinuationToken>
  </ReportInfo>
</StatusReporting.UsageReportDetectionAndResponse_Endpoint>