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/C3C6-EF83-8FC2-478E-960A/sites/dc86183b-3113-4f5b-8b47-e75edba15b22/dnsp/trafficsummary/categoryreport?startDate=2024-12-22T07:21:22.4343594Z&endDate=2025-01-21T07:21:22.4343594Z
|
Body Parameters
None.
Response Information
Resource Description
Traffic summary category report for a specific GSM site.
GetDNSPTrafficCategorySummaryForSiteResponseModel| 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-01-20T07:27:57.1003665Z",
"EndDate": "2025-01-21T07:27:57.1003665Z",
"Records": [
{
"CategoryId": 2,
"DNSRequests": 10597,
"AllowedDNSRequests": 7595,
"BlockedDNSRequests": 3002
},
{
"CategoryId": 3,
"DNSRequests": 10198,
"AllowedDNSRequests": 6557,
"BlockedDNSRequests": 3641
}
]
}
<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-01-21T07:27:57.1003665Z</EndDate>
<Records>
<GetDNSPTrafficCategorySummaryResponseModelRecord>
<AllowedDNSRequests>7595</AllowedDNSRequests>
<BlockedDNSRequests>3002</BlockedDNSRequests>
<CategoryId>2</CategoryId>
<DNSRequests>10597</DNSRequests>
</GetDNSPTrafficCategorySummaryResponseModelRecord>
<GetDNSPTrafficCategorySummaryResponseModelRecord>
<AllowedDNSRequests>6557</AllowedDNSRequests>
<BlockedDNSRequests>3641</BlockedDNSRequests>
<CategoryId>3</CategoryId>
<DNSRequests>10198</DNSRequests>
</GetDNSPTrafficCategorySummaryResponseModelRecord>
</Records>
<StartDate>2025-01-20T07:27:57.1003665Z</StartDate>
</GetDNSPTrafficCategorySummaryForSiteResponseModel>