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/03C3-5E1B-A79C-41B6-BBDA/dnsp/trafficsummary/categoryreport?startDate=2025-03-20T01:21:35.7823096Z&endDate=2025-04-19T01:21:35.7823096Z
|
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-04-18T01:51:35.6997894Z", "EndDate": "2025-04-19T01:51:35.6997894Z", "Records": [ { "CategoryId": 2, "DNSRequests": 13566, "AllowedDNSRequests": 10496, "BlockedDNSRequests": 3070 }, { "CategoryId": 3, "DNSRequests": 10208, "AllowedDNSRequests": 7930, "BlockedDNSRequests": 2278 } ] }
<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-04-19T01:51:35.6997894Z</EndDate> <Records> <GetDNSPTrafficCategorySummaryResponseModelRecord> <AllowedDNSRequests>10496</AllowedDNSRequests> <BlockedDNSRequests>3070</BlockedDNSRequests> <CategoryId>2</CategoryId> <DNSRequests>13566</DNSRequests> </GetDNSPTrafficCategorySummaryResponseModelRecord> <GetDNSPTrafficCategorySummaryResponseModelRecord> <AllowedDNSRequests>7930</AllowedDNSRequests> <BlockedDNSRequests>2278</BlockedDNSRequests> <CategoryId>3</CategoryId> <DNSRequests>10208</DNSRequests> </GetDNSPTrafficCategorySummaryResponseModelRecord> </Records> <StartDate>2025-04-18T01:51:35.6997894Z</StartDate> </GetDNSPTrafficCategorySummaryResponseModel>