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/8B72-D60B-0C65-4D32-B067/dnsp/trafficsummary?startDate=2024-11-21T02:47:08.0129850Z&endDate=2024-12-21T02:47:08.0129850Z
|
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": "2024-12-20T18:05:02.4093895Z", "EndDate": "2024-12-21T18:05:02.4093895Z", "Sites": [ { "SiteId": "38b77abc-d235-41d5-a063-3e7a12d56884", "SiteName": "Site 1", "DNSRequests": 12496, "BlockedDNSRequests": 131, "RiskyDNSRequests": 172 }, { "SiteId": "09b104b9-f483-45cc-a537-6e9bce392d28", "SiteName": "Site 2", "DNSRequests": 13682, "BlockedDNSRequests": 119, "RiskyDNSRequests": 122 } ] }
<GetDNSPTrafficSummaryResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <EndDate>2024-12-21T18:05:02.4093895Z</EndDate> <Sites> <GetDNSPTrafficSummaryResponseModel_Site> <BlockedDNSRequests>131</BlockedDNSRequests> <DNSRequests>12496</DNSRequests> <RiskyDNSRequests>172</RiskyDNSRequests> <SiteId>38b77abc-d235-41d5-a063-3e7a12d56884</SiteId> <SiteName>Site 1</SiteName> </GetDNSPTrafficSummaryResponseModel_Site> <GetDNSPTrafficSummaryResponseModel_Site> <BlockedDNSRequests>119</BlockedDNSRequests> <DNSRequests>13682</DNSRequests> <RiskyDNSRequests>122</RiskyDNSRequests> <SiteId>09b104b9-f483-45cc-a537-6e9bce392d28</SiteId> <SiteName>Site 2</SiteName> </GetDNSPTrafficSummaryResponseModel_Site> </Sites> <StartDate>2024-12-20T18:05:02.4093895Z</StartDate> </GetDNSPTrafficSummaryResponseModel>