GET /service/api/console/gsm/{gsmKey}/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 given GSM.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
gsmKey |
The GSM console keycode. |
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/5D04-2835-01A4-4528-B9F9/dnsp/trafficsummary/categoryreport?startDate=2025-04-09T14:28:30.8776901Z&endDate=2025-05-09T14:28:30.8776901Z
|
Body Parameters
None.
Response Information
Resource Description
Traffic summary category report for a given GSM console.
GetDNSPTrafficCategorySummaryResponseModelName | 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-08T15:58:02.6509285Z", "EndDate": "2025-05-09T15:58:02.6509285Z", "Records": [ { "CategoryId": 2, "DNSRequests": 14873, "AllowedDNSRequests": 11936, "BlockedDNSRequests": 2937 }, { "CategoryId": 3, "DNSRequests": 11915, "AllowedDNSRequests": 10800, "BlockedDNSRequests": 1115 } ] }
<GetDNSPTrafficCategorySummaryResponseModel 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-09T15:58:02.6509285Z</EndDate> <Records> <GetDNSPTrafficCategorySummaryResponseModelRecord> <AllowedDNSRequests>11936</AllowedDNSRequests> <BlockedDNSRequests>2937</BlockedDNSRequests> <CategoryId>2</CategoryId> <DNSRequests>14873</DNSRequests> </GetDNSPTrafficCategorySummaryResponseModelRecord> <GetDNSPTrafficCategorySummaryResponseModelRecord> <AllowedDNSRequests>10800</AllowedDNSRequests> <BlockedDNSRequests>1115</BlockedDNSRequests> <CategoryId>3</CategoryId> <DNSRequests>11915</DNSRequests> </GetDNSPTrafficCategorySummaryResponseModelRecord> </Records> <StartDate>2025-05-08T15:58:02.6509285Z</StartDate> </GetDNSPTrafficCategorySummaryResponseModel>