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/4030-657B-2C41-4FC3-BECB/sites/1f6fd6fc-1c41-46e0-8aa7-36c8e6b6cbdf/dnsp/trafficsummary/categoryuserreport?startDate=2025-06-14T18:45:36.3157460Z&endDate=2025-07-14T18:45:36.3157460Z&categories=7,42,47
|
Body Parameters
None.
Response Information
Resource Description
Traffic summary category user report for a specific GSM site.
GetDNSPTrafficCategoryUserSummaryForSiteResponseModelName | 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": "2025-07-14T21:14:01.6136575Z", "EndDate": "2025-07-15T21:14:01.6136575Z", "Records": [ { "CategoryId": 2, "Users": [ { "UserName": "User1", "AllowedDNSRequests": 12984, "BlockedDNSRequests": 2768 }, { "UserName": "User2", "AllowedDNSRequests": 14134, "BlockedDNSRequests": 3310 } ] }, { "CategoryId": 3, "Users": [ { "UserName": "User1", "AllowedDNSRequests": 13941, "BlockedDNSRequests": 1655 }, { "UserName": "User2", "AllowedDNSRequests": 13104, "BlockedDNSRequests": 1673 } ] } ] }
<GetDNSPTrafficCategoryUserSummaryForSiteResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models.DNSProtection"> <EndDate>2025-07-15T21:14:01.6136575Z</EndDate> <Records> <GetDNSPTrafficCategoryUserSummaryResponseModelRecord> <CategoryId>2</CategoryId> <Users> <GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser> <AllowedDNSRequests>12984</AllowedDNSRequests> <BlockedDNSRequests>2768</BlockedDNSRequests> <UserName>User1</UserName> </GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser> <GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser> <AllowedDNSRequests>14134</AllowedDNSRequests> <BlockedDNSRequests>3310</BlockedDNSRequests> <UserName>User2</UserName> </GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser> </Users> </GetDNSPTrafficCategoryUserSummaryResponseModelRecord> <GetDNSPTrafficCategoryUserSummaryResponseModelRecord> <CategoryId>3</CategoryId> <Users> <GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser> <AllowedDNSRequests>13941</AllowedDNSRequests> <BlockedDNSRequests>1655</BlockedDNSRequests> <UserName>User1</UserName> </GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser> <GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser> <AllowedDNSRequests>13104</AllowedDNSRequests> <BlockedDNSRequests>1673</BlockedDNSRequests> <UserName>User2</UserName> </GetDNSPTrafficCategoryUserSummaryResponseModelRecordUser> </Users> </GetDNSPTrafficCategoryUserSummaryResponseModelRecord> </Records> <StartDate>2025-07-14T21:14:01.6136575Z</StartDate> </GetDNSPTrafficCategoryUserSummaryForSiteResponseModel>