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/72B3-F60B-1C48-4BD0-85D7/sites/7727c2d8-c0c0-4c4d-9bd3-30997907968b/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 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-07-26T06:03:27.6500008Z", "EndDate": "2024-07-27T06:03:27.6500008Z", "Sites": [ { "SiteId": "a9915672-da91-43c3-a406-ad46f8f76a9f", "SiteName": "Site 1", "DNSRequests": 10288, "BlockedDNSRequests": 128, "RiskyDNSRequests": 144 } ] }
<GetDNSPTrafficSummaryForSiteResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <EndDate>2024-07-27T06:03:27.6500008Z</EndDate> <Sites> <GetDNSPTrafficSummaryResponseModel_Site> <BlockedDNSRequests>128</BlockedDNSRequests> <DNSRequests>10288</DNSRequests> <RiskyDNSRequests>144</RiskyDNSRequests> <SiteId>a9915672-da91-43c3-a406-ad46f8f76a9f</SiteId> <SiteName>Site 1</SiteName> </GetDNSPTrafficSummaryResponseModel_Site> </Sites> <StartDate>2024-07-26T06:03:27.6500008Z</StartDate> </GetDNSPTrafficSummaryForSiteResponseModel>