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/5939-7B8A-8F8E-42B1-9F9B/dnsp/trafficsummary/categoryreport?startDate=2025-01-22T17:24:29.5784079Z&endDate=2025-02-21T17:24:29.5784079Z
|
Body Parameters
None.
Response Information
Resource Description
Traffic summary category report for a given GSM console.
GetDNSPTrafficCategorySummaryResponseModel| Name | 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-02-21T08:51:47.9259511Z",
"EndDate": "2025-02-22T08:51:47.9259511Z",
"Records": [
{
"CategoryId": 2,
"DNSRequests": 10206,
"AllowedDNSRequests": 7687,
"BlockedDNSRequests": 2519
},
{
"CategoryId": 3,
"DNSRequests": 12808,
"AllowedDNSRequests": 11797,
"BlockedDNSRequests": 1011
}
]
}
<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-02-22T08:51:47.9259511Z</EndDate>
<Records>
<GetDNSPTrafficCategorySummaryResponseModelRecord>
<AllowedDNSRequests>7687</AllowedDNSRequests>
<BlockedDNSRequests>2519</BlockedDNSRequests>
<CategoryId>2</CategoryId>
<DNSRequests>10206</DNSRequests>
</GetDNSPTrafficCategorySummaryResponseModelRecord>
<GetDNSPTrafficCategorySummaryResponseModelRecord>
<AllowedDNSRequests>11797</AllowedDNSRequests>
<BlockedDNSRequests>1011</BlockedDNSRequests>
<CategoryId>3</CategoryId>
<DNSRequests>12808</DNSRequests>
</GetDNSPTrafficCategorySummaryResponseModelRecord>
</Records>
<StartDate>2025-02-21T08:51:47.9259511Z</StartDate>
</GetDNSPTrafficCategorySummaryResponseModel>