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/E154-5CB8-67B1-4B22-88BC/dnsp/trafficsummary?startDate=2025-07-18T13:04:05.1774683Z&endDate=2025-08-17T13:04:05.1774683Z
|
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-08-16T14:09:20.1849909Z", "EndDate": "2025-08-17T14:09:20.1849909Z", "Sites": [ { "SiteId": "29ea6584-88ff-4eba-9e03-cac3bebf7273", "SiteName": "Site 1", "DNSRequests": 10223, "BlockedDNSRequests": 163, "RiskyDNSRequests": 193 }, { "SiteId": "657e1e2d-9179-45d1-bc72-20ce26cf6ca6", "SiteName": "Site 2", "DNSRequests": 13783, "BlockedDNSRequests": 139, "RiskyDNSRequests": 104 } ] }
<GetDNSPTrafficSummaryResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <EndDate>2025-08-17T14:09:20.1849909Z</EndDate> <Sites> <GetDNSPTrafficSummaryResponseModel_Site> <BlockedDNSRequests>163</BlockedDNSRequests> <DNSRequests>10223</DNSRequests> <RiskyDNSRequests>193</RiskyDNSRequests> <SiteId>29ea6584-88ff-4eba-9e03-cac3bebf7273</SiteId> <SiteName>Site 1</SiteName> </GetDNSPTrafficSummaryResponseModel_Site> <GetDNSPTrafficSummaryResponseModel_Site> <BlockedDNSRequests>139</BlockedDNSRequests> <DNSRequests>13783</DNSRequests> <RiskyDNSRequests>104</RiskyDNSRequests> <SiteId>657e1e2d-9179-45d1-bc72-20ce26cf6ca6</SiteId> <SiteName>Site 2</SiteName> </GetDNSPTrafficSummaryResponseModel_Site> </Sites> <StartDate>2025-08-16T14:09:20.1849909Z</StartDate> </GetDNSPTrafficSummaryResponseModel>