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 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
Name | Description | Type | Additional 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:
|
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/D6AD-4731-9B66-4C48-9ED8/sites/D008-D8F3-4D0F-4E50-BD00/dnsp?reportType=DevicesSeen&effectiveDate=2024-09-02T00:00:00.0000000Z
|
Body Parameters
None.
Response Information
Resource Description
Returns a list of site keycode usage statistics having the specified master key as parent.
UsageReportSite_DNSPName | Description | Type | Additional 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": "DevicesSeenInLast30Days", "EffectiveDate": "2024-08-17T00:00:00Z", "GSMKey": "fbs0yd4w28410ilfx96k" }, "Sites": [ { "SiteId": "1309df19-73c5-672d-76bd-55caae1a5ba3", "SiteKey": "vwbooepy2emxz86ws5u0", "SiteName": "Site YSRO4ZM5TH", "SiteLicenseType": "Full", "SiteExpiryDate": "2025-07-08T09:43:36.6635241Z", "SiteState": "active", "SiteStateChangedDate": "2024-08-29T01:42:36.6635241Z", "DNSPEnabled": true, "DNSPLicenseType": "Full", "DNSPExpiryDate": "2024-12-26T07:24:36.6635241Z", "TotalDNSPDevicesProxy": 22, "TotalDNSPDevicesActual": 41, "TotalDNSPAgentlessRequests": 780000, "TotalDNSPAgents": 15 } ] }
<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>2024-08-17T00:00:00Z</EffectiveDate> <GSMKey>fbs0yd4w28410ilfx96k</GSMKey> <ReportType>DevicesSeenInLast30Days</ReportType> <Count>1</Count> <SiteKeyFilter i:nil="true" /> </ReportInfo> <Sites> <StatusReporting.UsageReportSites_DNSP_SiteEntry> <DNSPEnabled>true</DNSPEnabled> <DNSPExpiryDate>2024-12-26T07:24:36.6635241Z</DNSPExpiryDate> <DNSPLicenseType>Full</DNSPLicenseType> <SiteExpiryDate>2025-07-08T09:43:36.6635241Z</SiteExpiryDate> <SiteId>1309df19-73c5-672d-76bd-55caae1a5ba3</SiteId> <SiteKey>vwbooepy2emxz86ws5u0</SiteKey> <SiteLicenseType>Full</SiteLicenseType> <SiteName>Site YSRO4ZM5TH</SiteName> <SiteState>active</SiteState> <SiteStateChangedDate>2024-08-29T01:42:36.6635241Z</SiteStateChangedDate> <TotalDNSPAgentlessRequests>780000</TotalDNSPAgentlessRequests> <TotalDNSPAgents>15</TotalDNSPAgents> <TotalDNSPDevicesActual>41</TotalDNSPDevicesActual> <TotalDNSPDevicesProxy>22</TotalDNSPDevicesProxy> </StatusReporting.UsageReportSites_DNSP_SiteEntry> </Sites> </StatusReporting.UsageReportSite_DNSP>