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/FA49-EF4E-6F70-434F-B549/dnsp/trafficsummary?startDate=2025-08-08T01:49:26.6242792Z&endDate=2025-09-07T01:49:26.6242792Z
|
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-09-06T03:14:13.2201627Z", "EndDate": "2025-09-07T03:14:13.2201627Z", "Sites": [ { "SiteId": "54f9091c-0719-4792-b41f-6f832f6611a3", "SiteName": "Site 1", "DNSRequests": 12407, "BlockedDNSRequests": 143, "RiskyDNSRequests": 167 }, { "SiteId": "f30b1fb4-3160-48e5-bd9c-0bce46b4fcba", "SiteName": "Site 2", "DNSRequests": 12062, "BlockedDNSRequests": 135, "RiskyDNSRequests": 175 } ] }
<GetDNSPTrafficSummaryResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <EndDate>2025-09-07T03:14:13.2201627Z</EndDate> <Sites> <GetDNSPTrafficSummaryResponseModel_Site> <BlockedDNSRequests>143</BlockedDNSRequests> <DNSRequests>12407</DNSRequests> <RiskyDNSRequests>167</RiskyDNSRequests> <SiteId>54f9091c-0719-4792-b41f-6f832f6611a3</SiteId> <SiteName>Site 1</SiteName> </GetDNSPTrafficSummaryResponseModel_Site> <GetDNSPTrafficSummaryResponseModel_Site> <BlockedDNSRequests>135</BlockedDNSRequests> <DNSRequests>12062</DNSRequests> <RiskyDNSRequests>175</RiskyDNSRequests> <SiteId>f30b1fb4-3160-48e5-bd9c-0bce46b4fcba</SiteId> <SiteName>Site 2</SiteName> </GetDNSPTrafficSummaryResponseModel_Site> </Sites> <StartDate>2025-09-06T03:14:13.2201627Z</StartDate> </GetDNSPTrafficSummaryResponseModel>