GET /service/api/console/gsm/{gsmKey}/dnsp/trafficsummary
?startDate={startDate}
&endDate={endDate}
Returns a traffic summary (e.g. the number of total DNS requests, blocked DNS requests, and risky DNS requests) for each site under a given GSM.
NOTE: The maximum allowed time difference between 'startDate' and
'endDate' is 30 days.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
gsmKey |
The GSM console keycode. |
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/2170-BA50-5C8B-41BA-ADC0/dnsp/trafficsummary?startDate=2025-04-29T15:00:53.9451204Z&endDate=2025-05-29T15:00:53.9451204Z
|
Body Parameters
None.
Response Information
Resource Description
Traffic summary information for GSM sites.
GetDNSPTrafficSummaryResponseModelName | 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. |
Sites |
The list of sites. |
Collection of GetDNSPTrafficSummaryResponseModel_Site |
None. |
Sample Response
{ "StartDate": "2025-05-29T17:39:16.4879052Z", "EndDate": "2025-05-30T17:39:16.4879052Z", "Sites": [ { "SiteId": "8e8c9380-e0c3-4b1a-b9f3-270cc722b162", "SiteName": "Site 1", "DNSRequests": 13634, "BlockedDNSRequests": 185, "RiskyDNSRequests": 104 }, { "SiteId": "7dffde1f-c8c9-4e77-8168-be72845d3ac2", "SiteName": "Site 2", "DNSRequests": 10080, "BlockedDNSRequests": 145, "RiskyDNSRequests": 155 } ] }
<GetDNSPTrafficSummaryResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <EndDate>2025-05-30T17:39:16.4879052Z</EndDate> <Sites> <GetDNSPTrafficSummaryResponseModel_Site> <BlockedDNSRequests>185</BlockedDNSRequests> <DNSRequests>13634</DNSRequests> <RiskyDNSRequests>104</RiskyDNSRequests> <SiteId>8e8c9380-e0c3-4b1a-b9f3-270cc722b162</SiteId> <SiteName>Site 1</SiteName> </GetDNSPTrafficSummaryResponseModel_Site> <GetDNSPTrafficSummaryResponseModel_Site> <BlockedDNSRequests>145</BlockedDNSRequests> <DNSRequests>10080</DNSRequests> <RiskyDNSRequests>155</RiskyDNSRequests> <SiteId>7dffde1f-c8c9-4e77-8168-be72845d3ac2</SiteId> <SiteName>Site 2</SiteName> </GetDNSPTrafficSummaryResponseModel_Site> </Sites> <StartDate>2025-05-29T17:39:16.4879052Z</StartDate> </GetDNSPTrafficSummaryResponseModel>