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/EB60-12A5-DF0B-41A6-B12F/dnsp/trafficsummary?startDate=2025-06-01T11:32:10.8025516Z&endDate=2025-07-01T11:32:10.8025516Z
|
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-07-01T04:49:42.3074966Z", "EndDate": "2025-07-02T04:49:42.3074966Z", "Sites": [ { "SiteId": "236a1a94-7024-4cf6-bfbf-158a09fefdda", "SiteName": "Site 1", "DNSRequests": 14019, "BlockedDNSRequests": 152, "RiskyDNSRequests": 153 }, { "SiteId": "63cd1dca-6a19-40cc-ac27-8037dbe19ac7", "SiteName": "Site 2", "DNSRequests": 13079, "BlockedDNSRequests": 120, "RiskyDNSRequests": 111 } ] }
<GetDNSPTrafficSummaryResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <EndDate>2025-07-02T04:49:42.3074966Z</EndDate> <Sites> <GetDNSPTrafficSummaryResponseModel_Site> <BlockedDNSRequests>152</BlockedDNSRequests> <DNSRequests>14019</DNSRequests> <RiskyDNSRequests>153</RiskyDNSRequests> <SiteId>236a1a94-7024-4cf6-bfbf-158a09fefdda</SiteId> <SiteName>Site 1</SiteName> </GetDNSPTrafficSummaryResponseModel_Site> <GetDNSPTrafficSummaryResponseModel_Site> <BlockedDNSRequests>120</BlockedDNSRequests> <DNSRequests>13079</DNSRequests> <RiskyDNSRequests>111</RiskyDNSRequests> <SiteId>63cd1dca-6a19-40cc-ac27-8037dbe19ac7</SiteId> <SiteName>Site 2</SiteName> </GetDNSPTrafficSummaryResponseModel_Site> </Sites> <StartDate>2025-07-01T04:49:42.3074966Z</StartDate> </GetDNSPTrafficSummaryResponseModel>