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/1B69-8E3D-44BE-4CFE-83C2/sites/239a1b88-97e9-420d-acb3-d185ca55f95f/dnsp/trafficsummary/categoryreport?startDate=2025-04-09T14:43:47.1281482Z&endDate=2025-05-09T14:43:47.1281482Z
|
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-08T17:49:42.9556678Z", "EndDate": "2025-05-09T17:49:42.9556678Z", "Records": [ { "CategoryId": 2, "DNSRequests": 11431, "AllowedDNSRequests": 10204, "BlockedDNSRequests": 1227 }, { "CategoryId": 3, "DNSRequests": 10077, "AllowedDNSRequests": 8459, "BlockedDNSRequests": 1618 } ] }
<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-09T17:49:42.9556678Z</EndDate> <Records> <GetDNSPTrafficCategorySummaryResponseModelRecord> <AllowedDNSRequests>10204</AllowedDNSRequests> <BlockedDNSRequests>1227</BlockedDNSRequests> <CategoryId>2</CategoryId> <DNSRequests>11431</DNSRequests> </GetDNSPTrafficCategorySummaryResponseModelRecord> <GetDNSPTrafficCategorySummaryResponseModelRecord> <AllowedDNSRequests>8459</AllowedDNSRequests> <BlockedDNSRequests>1618</BlockedDNSRequests> <CategoryId>3</CategoryId> <DNSRequests>10077</DNSRequests> </GetDNSPTrafficCategorySummaryResponseModelRecord> </Records> <StartDate>2025-05-08T17:49:42.9556678Z</StartDate> </GetDNSPTrafficCategorySummaryForSiteResponseModel>