Unity API Documentation

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

Returns a GSM-level summary report of DNSP usage for a GSM master keycode. Besides general information like the console name and type of GSM license the report includes the total number of sites and devices.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

A master keycode 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.

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/status/reporting/gsm/1619-F10C-11E7-4915-A38B/dnsp?reportType=DevicesSeen&effectiveDate=2024-04-20T00:00:00.0000000Z

Body Parameters

None.

Response Information

Resource Description

Returns usage statistics for a GSM master keycode.

UsageReportGSM_DNSP
NameDescriptionTypeAdditional Information
ReportInfo

Details about the returned report.

 UsageReportGSM_ReportInfo

None.
GSM

Details for a given GSM site.

 UsageReportGSM_DNSP_GSMEntry

None.

Sample Response

{
  "ReportInfo": {
    "ReportType": "DevicesSeen",
    "EffectiveDate": "2024-04-21T00:00:00Z",
    "GSMKey": "fsnapc2yprnd7kctwavn"
  },
  "GSM": {
    "GSMConsoleName": "GSM IJLPNRHCD4",
    "GSMLicenseType": "Full",
    "GSMExpiryDate": "2026-04-02T19:21:00.5073306Z",
    "DNSPEnabled": true,
    "DNSPLicenseType": "Full",
    "DNSPExpiryDate": "2025-09-26T10:19:00.5073306Z",
    "TotalSitesWithoutDNSP": 458,
    "TotalSitesWithDNSPFull": 9,
    "TotalSitesWithDNSPTrial": 220,
    "TotalDNSPDevicesProxyFull": 758,
    "TotalDNSPDevicesProxyTrial": 760,
    "TotalDNSPDevicesActualFull": 695,
    "TotalDNSPDevicesActualTrial": 821,
    "TotalDNSPAgentlessRequestsFull": 1980000,
    "TotalDNSPAgentlessRequestsTrial": 5160000,
    "TotalDNSPAgentsFull": 629,
    "TotalDNSPAgentsTrial": 755
  }
}                    
<StatusReporting.UsageReportGSM_DNSP xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.AgentStatus.Models">
  <GSM>
    <DNSPEnabled>true</DNSPEnabled>
    <DNSPExpiryDate>2025-09-26T10:19:00.5073306Z</DNSPExpiryDate>
    <DNSPLicenseType>Full</DNSPLicenseType>
    <GSMConsoleName>GSM IJLPNRHCD4</GSMConsoleName>
    <GSMExpiryDate>2026-04-02T19:21:00.5073306Z</GSMExpiryDate>
    <GSMLicenseType>Full</GSMLicenseType>
    <TotalDNSPAgentlessRequestsFull>1980000</TotalDNSPAgentlessRequestsFull>
    <TotalDNSPAgentlessRequestsTrial>5160000</TotalDNSPAgentlessRequestsTrial>
    <TotalDNSPAgentsFull>629</TotalDNSPAgentsFull>
    <TotalDNSPAgentsTrial>755</TotalDNSPAgentsTrial>
    <TotalDNSPDevicesActualFull>695</TotalDNSPDevicesActualFull>
    <TotalDNSPDevicesActualTrial>821</TotalDNSPDevicesActualTrial>
    <TotalDNSPDevicesProxyFull>758</TotalDNSPDevicesProxyFull>
    <TotalDNSPDevicesProxyTrial>760</TotalDNSPDevicesProxyTrial>
    <TotalSitesWithDNSPFull>9</TotalSitesWithDNSPFull>
    <TotalSitesWithDNSPTrial>220</TotalSitesWithDNSPTrial>
    <TotalSitesWithoutDNSP>458</TotalSitesWithoutDNSP>
  </GSM>
  <ReportInfo>
    <EffectiveDate>2024-04-21T00:00:00Z</EffectiveDate>
    <GSMKey>fsnapc2yprnd7kctwavn</GSMKey>
    <ReportType>DevicesSeen</ReportType>
  </ReportInfo>
</StatusReporting.UsageReportGSM_DNSP>