GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/dnsp/trafficsummary/categoryreport
?startDate={startDate}
&endDate={endDate}
Returns a traffic summary (e.g. the number of total DNS requests, blocked DNS requests, and allowed DNS requests) grouped by categories for a specific site under a given GSM.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
gsmKey |
The GSM console keycode. |
string |
Required |
siteId |
The GSM site identifier. |
string |
Required |
startDate |
If specified, returns DNS traffic summary after (or at) the given date. If omitted, defaults to 'endDate' minus 24 hours. |
date |
None. |
endDate |
If specified, returns DNS traffic summary before (or at) the given date. If omitted, defaults to the current date and time. |
date |
None. |
URI Sample(s)
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/677B-8D6B-3B55-48FE-811A/sites/3963550b-ef6d-4a1c-9761-0b2613719436/dnsp/trafficsummary/categoryreport?startDate=2025-02-26T18:37:35.9846087Z&endDate=2025-03-28T18:37:35.9846087Z
|
Body Parameters
None.
Response Information
Resource Description
Traffic summary category report for a specific GSM site.
GetDNSPTrafficCategorySummaryForSiteResponseModelName | Description | Type | Additional Information |
---|---|---|---|
StartDate |
Start date for returned records. Traffic summary records after (or at) this date are contained in the response. |
date |
None. |
EndDate |
End date for returned records. Traffic summary records before (or at) this date are contained in the response. |
date |
None. |
Records |
A list of DNSP traffic records. |
Collection of GetDNSPTrafficCategorySummaryResponseModelRecord |
None. |
Sample Response
{ "StartDate": "2025-03-28T03:48:36.6485359Z", "EndDate": "2025-03-29T03:48:36.6485359Z", "Records": [ { "CategoryId": 2, "DNSRequests": 13835, "AllowedDNSRequests": 12136, "BlockedDNSRequests": 1699 }, { "CategoryId": 3, "DNSRequests": 11062, "AllowedDNSRequests": 8030, "BlockedDNSRequests": 3032 } ] }
<GetDNSPTrafficCategorySummaryForSiteResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models.DNSProtection"> <EndDate>2025-03-29T03:48:36.6485359Z</EndDate> <Records> <GetDNSPTrafficCategorySummaryResponseModelRecord> <AllowedDNSRequests>12136</AllowedDNSRequests> <BlockedDNSRequests>1699</BlockedDNSRequests> <CategoryId>2</CategoryId> <DNSRequests>13835</DNSRequests> </GetDNSPTrafficCategorySummaryResponseModelRecord> <GetDNSPTrafficCategorySummaryResponseModelRecord> <AllowedDNSRequests>8030</AllowedDNSRequests> <BlockedDNSRequests>3032</BlockedDNSRequests> <CategoryId>3</CategoryId> <DNSRequests>11062</DNSRequests> </GetDNSPTrafficCategorySummaryResponseModelRecord> </Records> <StartDate>2025-03-28T03:48:36.6485359Z</StartDate> </GetDNSPTrafficCategorySummaryForSiteResponseModel>