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/F1B0-A296-AD21-468B-A47A/sites/b803e8e7-edd2-4d88-999a-3db8df185702/dnsp/trafficsummary/categoryreport?startDate=2025-04-29T14:33:49.0456294Z&endDate=2025-05-29T14:33:49.0456294Z
|
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-05-29T18:56:29.3845464Z", "EndDate": "2025-05-30T18:56:29.3845464Z", "Records": [ { "CategoryId": 2, "DNSRequests": 12469, "AllowedDNSRequests": 11326, "BlockedDNSRequests": 1143 }, { "CategoryId": 3, "DNSRequests": 14785, "AllowedDNSRequests": 11251, "BlockedDNSRequests": 3534 } ] }
<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-05-30T18:56:29.3845464Z</EndDate> <Records> <GetDNSPTrafficCategorySummaryResponseModelRecord> <AllowedDNSRequests>11326</AllowedDNSRequests> <BlockedDNSRequests>1143</BlockedDNSRequests> <CategoryId>2</CategoryId> <DNSRequests>12469</DNSRequests> </GetDNSPTrafficCategorySummaryResponseModelRecord> <GetDNSPTrafficCategorySummaryResponseModelRecord> <AllowedDNSRequests>11251</AllowedDNSRequests> <BlockedDNSRequests>3534</BlockedDNSRequests> <CategoryId>3</CategoryId> <DNSRequests>14785</DNSRequests> </GetDNSPTrafficCategorySummaryResponseModelRecord> </Records> <StartDate>2025-05-29T18:56:29.3845464Z</StartDate> </GetDNSPTrafficCategorySummaryForSiteResponseModel>