Unity API Documentation

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.

NOTE: The maximum allowed time difference between 'startDate' and 'endDate' is 30 days.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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/BB11-A37F-EE87-41AD-A2DD/sites/a98d5864-ed0b-457d-80e1-55ca329fb2fe/dnsp/trafficsummary?startDate=2024-03-26T00:02:44.3824785Z&endDate=2024-04-25T00:02:44.3824785Z

Body Parameters

None.

Response Information

Resource Description

Traffic summary information for a specific GSM site.

GetDNSPTrafficSummaryForSiteResponseModel
NameDescriptionTypeAdditional 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-04-25T04:20:51.9041179Z",
  "EndDate": "2024-04-26T04:20:51.9041179Z",
  "Sites": [
    {
      "SiteId": "d0df396a-e215-4839-9bb8-b4a84b9d6454",
      "SiteName": "Site 1",
      "DNSRequests": 13628,
      "BlockedDNSRequests": 183,
      "RiskyDNSRequests": 160
    }
  ]
}                    
<GetDNSPTrafficSummaryForSiteResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <EndDate>2024-04-26T04:20:51.9041179Z</EndDate>
  <Sites>
    <GetDNSPTrafficSummaryResponseModel_Site>
      <BlockedDNSRequests>183</BlockedDNSRequests>
      <DNSRequests>13628</DNSRequests>
      <RiskyDNSRequests>160</RiskyDNSRequests>
      <SiteId>d0df396a-e215-4839-9bb8-b4a84b9d6454</SiteId>
      <SiteName>Site 1</SiteName>
    </GetDNSPTrafficSummaryResponseModel_Site>
  </Sites>
  <StartDate>2024-04-25T04:20:51.9041179Z</StartDate>
</GetDNSPTrafficSummaryForSiteResponseModel>