GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/dnsp/trafficsummary/categoryuserreport
?startDate={startDate}
&endDate={endDate}
&categories={categories}
Returns a traffic summary (e.g. the number of blocked DNS requests, allowed DNS requests, and user name) grouped by categories and users 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. |
| categories |
A comma separated list of one or more DNS Protection category identifiers (e.g. 14,47,81). Call 'get categories' to get a list of available DNS Protection categories and their respective identifiers. If omitted, defaults to all categories. |
string |
None. |
URI Sample(s)
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/51FC-F079-34B1-484F-8B74/sites/3ff63d51-23c4-4f43-8dc6-3bba0f17d050/dnsp/trafficsummary/categoryuserreport?startDate=2025-12-21T01:31:44.9805324Z&endDate=2026-01-20T01:31:44.9805324Z&categories=55,31,47
|
Body Parameters
None.
Response Information
Resource Description
Traffic summary category user report for a specific GSM site.
GetDNSPTrafficCategoryUserSummaryForSiteResponseModel| 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 category summary records. |
Collection of GetDNSPTrafficCategoryUserSummaryResponseModelRecord |
None. |
Sample Response
{
"StartDate": "2026-01-19T09:28:39.8660579Z",
"EndDate": "2026-01-20T09:28:39.8660579Z",
"Records": [
{
"CategoryId": 2,
"Users": [
{
"UserName": "User1",
"AllowedDNSRequests": 10837,
"BlockedDNSRequests": 2325
},
{
"UserName": "User2",
"AllowedDNSRequests": 11455,
"BlockedDNSRequests": 2363
}
]
},
{
"CategoryId": 3,
"Users": [
{
"UserName": "User1",
"AllowedDNSRequests": 14893,
"BlockedDNSRequests": 1516
},
{
"UserName": "User2",
"AllowedDNSRequests": 14992,
"BlockedDNSRequests": 3504
}
]
}
]
}
<GetDNSPTrafficCategoryUserSummaryForSiteResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models.DNSProtection">
<EndDate>2026-01-20T09:28:39.8660579Z</EndDate>
<Records>
<GetDNSPTrafficCategoryUserSummaryResponseModelRecord>
<CategoryId>2</CategoryId>
<Users>
<GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
<AllowedDNSRequests>10837</AllowedDNSRequests>
<BlockedDNSRequests>2325</BlockedDNSRequests>
<UserName>User1</UserName>
</GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
<GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
<AllowedDNSRequests>11455</AllowedDNSRequests>
<BlockedDNSRequests>2363</BlockedDNSRequests>
<UserName>User2</UserName>
</GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
</Users>
</GetDNSPTrafficCategoryUserSummaryResponseModelRecord>
<GetDNSPTrafficCategoryUserSummaryResponseModelRecord>
<CategoryId>3</CategoryId>
<Users>
<GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
<AllowedDNSRequests>14893</AllowedDNSRequests>
<BlockedDNSRequests>1516</BlockedDNSRequests>
<UserName>User1</UserName>
</GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
<GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
<AllowedDNSRequests>14992</AllowedDNSRequests>
<BlockedDNSRequests>3504</BlockedDNSRequests>
<UserName>User2</UserName>
</GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser>
</Users>
</GetDNSPTrafficCategoryUserSummaryResponseModelRecord>
</Records>
<StartDate>2026-01-19T09:28:39.8660579Z</StartDate>
</GetDNSPTrafficCategoryUserSummaryForSiteResponseModel>