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/431E-F03E-A713-4D9C-AE02/sites/508717de-5277-469f-9d91-dde88f7936b2/dnsp/trafficsummary/categoryreport?startDate=2024-11-21T02:47:52.9761639Z&endDate=2024-12-21T02:47:52.9761639Z
|
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": "2024-12-20T18:34:31.1586147Z",
"EndDate": "2024-12-21T18:34:31.1586147Z",
"Records": [
{
"CategoryId": 2,
"DNSRequests": 13879,
"AllowedDNSRequests": 12050,
"BlockedDNSRequests": 1829
},
{
"CategoryId": 3,
"DNSRequests": 13397,
"AllowedDNSRequests": 11239,
"BlockedDNSRequests": 2158
}
]
}
<GetDNSPTrafficCategorySummaryForSiteResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models.DNSProtection">
<EndDate>2024-12-21T18:34:31.1586147Z</EndDate>
<Records>
<GetDNSPTrafficCategorySummaryResponseModelRecord>
<AllowedDNSRequests>12050</AllowedDNSRequests>
<BlockedDNSRequests>1829</BlockedDNSRequests>
<CategoryId>2</CategoryId>
<DNSRequests>13879</DNSRequests>
</GetDNSPTrafficCategorySummaryResponseModelRecord>
<GetDNSPTrafficCategorySummaryResponseModelRecord>
<AllowedDNSRequests>11239</AllowedDNSRequests>
<BlockedDNSRequests>2158</BlockedDNSRequests>
<CategoryId>3</CategoryId>
<DNSRequests>13397</DNSRequests>
</GetDNSPTrafficCategorySummaryResponseModelRecord>
</Records>
<StartDate>2024-12-20T18:34:31.1586147Z</StartDate>
</GetDNSPTrafficCategorySummaryForSiteResponseModel>