GET /service/api/status/reporting/gsm/{gsmKey}/sites/{keyCode}/dnsp
 ?reportType={reportType}
 &effectiveDate={effectiveDate}

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

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

reportType

The type of report to be produced. The following values are supported:

  • "DevicesSeen": Provides DNSP statistics for all devices seen on the effective report date.
  • "DevicesSeenInLast30Days": Provides DNSP statistics for all devices seen in the last 30 days (between the effective report date and 30 days earlier).
If omitted, the reportType is set to "DevicesSeenInLast30Days".

string

None.

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.

Body Parameters

None.

Response Information

Resource Description

Returns a list of site keycode usage statistics having the specified master key as parent.

UsageReportSite_DNSP
NameDescriptionTypeAdditional Information
ReportInfo

Details about the returned report.

UsageReportSites_ReportInfo

None.

Sites

Site/endpoint details for a given GSM site.

Collection of UsageReportSites_DNSP_SiteEntry

None.

Sample Response

{
  "ReportInfo": {
    "Count": 1,
    "SiteKeyFilter": null,
    "ReportType": "DevicesSeen",
    "EffectiveDate": "2019-08-26T00:00:00Z",
    "GSMKey": "2TYI-9ZI3-AWDX-QW5E-TCWU"
  },
  "Sites": [
    {
      "SiteId": "086c4384-064c-39ba-7f05-5f2776772813",
      "SiteKey": "QSZK-NI8L-68QY-UUZ8-Z6X1",
      "SiteName": "Site X8ILPPKM7X",
      "SiteLicenseType": "Full",
      "SiteExpiryDate": "2020-09-22T06:55:35.3895785Z",
      "SiteState": "active",
      "SiteStateChangedDate": "2019-08-25T04:46:35.3895785Z",
      "DNSPEnabled": true,
      "DNSPLicenseType": "Full",
      "DNSPExpiryDate": "2020-06-22T12:18:35.3895785Z",
      "TotalDNSPDevicesProxy": 59,
      "TotalDNSPDevicesActual": 66,
      "TotalDNSPAgentlessRequests": 810000,
      "TotalDNSPAgents": 39
    }
  ]
}                    
<StatusReporting.UsageReportSite_DNSP xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.AgentStatus.Models">
  <ReportInfo>
    <EffectiveDate>2019-08-26T00:00:00Z</EffectiveDate>
    <GSMKey>2TYI-9ZI3-AWDX-QW5E-TCWU</GSMKey>
    <ReportType>DevicesSeen</ReportType>
    <Count>1</Count>
    <SiteKeyFilter i:nil="true" />
  </ReportInfo>
  <Sites>
    <StatusReporting.UsageReportSites_DNSP_SiteEntry>
      <DNSPEnabled>true</DNSPEnabled>
      <DNSPExpiryDate>2020-06-22T12:18:35.3895785Z</DNSPExpiryDate>
      <DNSPLicenseType>Full</DNSPLicenseType>
      <SiteExpiryDate>2020-09-22T06:55:35.3895785Z</SiteExpiryDate>
      <SiteId>086c4384-064c-39ba-7f05-5f2776772813</SiteId>
      <SiteKey>QSZK-NI8L-68QY-UUZ8-Z6X1</SiteKey>
      <SiteLicenseType>Full</SiteLicenseType>
      <SiteName>Site X8ILPPKM7X</SiteName>
      <SiteState>active</SiteState>
      <SiteStateChangedDate>2019-08-25T04:46:35.3895785Z</SiteStateChangedDate>
      <TotalDNSPAgentlessRequests>810000</TotalDNSPAgentlessRequests>
      <TotalDNSPAgents>39</TotalDNSPAgents>
      <TotalDNSPDevicesActual>66</TotalDNSPDevicesActual>
      <TotalDNSPDevicesProxy>59</TotalDNSPDevicesProxy>
    </StatusReporting.UsageReportSites_DNSP_SiteEntry>
  </Sites>
</StatusReporting.UsageReportSite_DNSP>