GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/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 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/1AFE-914D-083A-43FD-BC6B/sites/aa100584-5c89-49f6-b3f7-3f9a2975a80e/dnsp/trafficsummary?startDate=2024-10-10T12:36:39.2842323Z&endDate=2024-11-09T12:36:39.2842323Z
|
Body Parameters
None.
Response Information
Resource Description
Traffic summary information for a specific GSM site.
GetDNSPTrafficSummaryForSiteResponseModelName | 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": "2024-11-09T05:02:20.4261228Z", "EndDate": "2024-11-10T05:02:20.4261228Z", "Sites": [ { "SiteId": "4ce86c5b-dc86-4d1c-a74c-332453aecedf", "SiteName": "Site 1", "DNSRequests": 14996, "BlockedDNSRequests": 176, "RiskyDNSRequests": 185 } ] }
<GetDNSPTrafficSummaryForSiteResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <EndDate>2024-11-10T05:02:20.4261228Z</EndDate> <Sites> <GetDNSPTrafficSummaryResponseModel_Site> <BlockedDNSRequests>176</BlockedDNSRequests> <DNSRequests>14996</DNSRequests> <RiskyDNSRequests>185</RiskyDNSRequests> <SiteId>4ce86c5b-dc86-4d1c-a74c-332453aecedf</SiteId> <SiteName>Site 1</SiteName> </GetDNSPTrafficSummaryResponseModel_Site> </Sites> <StartDate>2024-11-09T05:02:20.4261228Z</StartDate> </GetDNSPTrafficSummaryForSiteResponseModel>