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. |
Body Parameters
None.
Response Information
Resource Description
Traffic summary information for a specific GSM site.
GetDNSPTrafficSummaryForSiteResponseModel| Name | 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": "2019-07-17T15:31:48.7672869Z",
"EndDate": "2019-07-18T15:31:48.7672869Z",
"Sites": [
{
"SiteId": "263f7123-60dc-4a7f-861b-d998783527fd",
"SiteName": "Site 1",
"DNSRequests": 11296,
"BlockedDNSRequests": 167,
"RiskyDNSRequests": 162
}
]
}
<GetDNSPTrafficSummaryForSiteResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
<EndDate>2019-07-18T15:31:48.7672869Z</EndDate>
<Sites>
<GetDNSPTrafficSummaryResponseModel_Site>
<BlockedDNSRequests>167</BlockedDNSRequests>
<DNSRequests>11296</DNSRequests>
<RiskyDNSRequests>162</RiskyDNSRequests>
<SiteId>263f7123-60dc-4a7f-861b-d998783527fd</SiteId>
<SiteName>Site 1</SiteName>
</GetDNSPTrafficSummaryResponseModel_Site>
</Sites>
<StartDate>2019-07-17T15:31:48.7672869Z</StartDate>
</GetDNSPTrafficSummaryForSiteResponseModel>