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/F8DD-400B-1F54-4E8B-9555/dnsp/trafficsummary?startDate=2024-06-26T09:36:06.2037746Z&endDate=2024-07-26T09:36:06.2037746Z
|
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-07-26T09:11:24.7612131Z", "EndDate": "2024-07-27T09:11:24.7612131Z", "Sites": [ { "SiteId": "b5bd5cc7-7500-454c-ab97-4969ee4191c0", "SiteName": "Site 1", "DNSRequests": 13321, "BlockedDNSRequests": 188, "RiskyDNSRequests": 130 }, { "SiteId": "f3a8fece-46c3-4f4d-9ee9-b135f3e34445", "SiteName": "Site 2", "DNSRequests": 11820, "BlockedDNSRequests": 169, "RiskyDNSRequests": 147 } ] }
<GetDNSPTrafficSummaryResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <EndDate>2024-07-27T09:11:24.7612131Z</EndDate> <Sites> <GetDNSPTrafficSummaryResponseModel_Site> <BlockedDNSRequests>188</BlockedDNSRequests> <DNSRequests>13321</DNSRequests> <RiskyDNSRequests>130</RiskyDNSRequests> <SiteId>b5bd5cc7-7500-454c-ab97-4969ee4191c0</SiteId> <SiteName>Site 1</SiteName> </GetDNSPTrafficSummaryResponseModel_Site> <GetDNSPTrafficSummaryResponseModel_Site> <BlockedDNSRequests>169</BlockedDNSRequests> <DNSRequests>11820</DNSRequests> <RiskyDNSRequests>147</RiskyDNSRequests> <SiteId>f3a8fece-46c3-4f4d-9ee9-b135f3e34445</SiteId> <SiteName>Site 2</SiteName> </GetDNSPTrafficSummaryResponseModel_Site> </Sites> <StartDate>2024-07-26T09:11:24.7612131Z</StartDate> </GetDNSPTrafficSummaryResponseModel>