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/6BDA-A0AE-98AD-443C-A14B/sites/af09b0bf-0a28-447f-8b3e-74915d9169a7/dnsp/trafficsummary/categoryreport?startDate=2024-08-08T18:53:50.7334238Z&endDate=2024-09-07T18:53:50.7334238Z
|
Body Parameters
None.
Response Information
Resource Description
Traffic summary category report for a specific GSM site.
GetDNSPTrafficCategorySummaryForSiteResponseModelName | 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-09-07T03:17:02.2917611Z", "EndDate": "2024-09-08T03:17:02.2917611Z", "Records": [ { "CategoryId": 2, "DNSRequests": 14354, "AllowedDNSRequests": 11015, "BlockedDNSRequests": 3339 }, { "CategoryId": 3, "DNSRequests": 13319, "AllowedDNSRequests": 11638, "BlockedDNSRequests": 1681 } ] }
<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-09-08T03:17:02.2917611Z</EndDate> <Records> <GetDNSPTrafficCategorySummaryResponseModelRecord> <AllowedDNSRequests>11015</AllowedDNSRequests> <BlockedDNSRequests>3339</BlockedDNSRequests> <CategoryId>2</CategoryId> <DNSRequests>14354</DNSRequests> </GetDNSPTrafficCategorySummaryResponseModelRecord> <GetDNSPTrafficCategorySummaryResponseModelRecord> <AllowedDNSRequests>11638</AllowedDNSRequests> <BlockedDNSRequests>1681</BlockedDNSRequests> <CategoryId>3</CategoryId> <DNSRequests>13319</DNSRequests> </GetDNSPTrafficCategorySummaryResponseModelRecord> </Records> <StartDate>2024-09-07T03:17:02.2917611Z</StartDate> </GetDNSPTrafficCategorySummaryForSiteResponseModel>