GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/blockedurls/counts
 ?includeDeactivated={includeDeactivated}
 &includeHidden={includeHidden}
 &startDate={startDate}
 &endDate={endDate}

Retrieves per-day summary counts of the number of recorded URL actions on endpoints in the given site.

NOTE: Blocked URLs data is generally available for as far as 90 days in the past. However, the maximum allowed time range between 'startDate' and 'endDate' is 30 days.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

string

Required

siteId

The site identifier.

string

Required

includeDeactivated

Value indicating whether URL actions of endpoints that are currently deactivated should be included in the counts.

boolean

Default is false

includeHidden

Value indicating whether URL actions of endpoints that are currently hidden should be included in the counts.

boolean

Default is false

startDate

The start date of the time range for which data is queried.

Note: The earliest count value returned is for the first FULL day following the date specified in startDate. For example, passing "2021-02-15Z" or "2021-02-15T00:00Z" will include the count for the 15th of February 2021. When the start date is "2021-02-15T12:45Z", returned counts will start with February 16th.

date

Default value is endDate minus 7 days.

endDate

The end date of the time range for which data is queried.

Note: The value returned for the last day in the time range is the number of URL actions counted for that day, up to the time-of-day specified in endDate.

date

Default value is the current date and time.

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/blockedurls/counts
GET
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/blockedurls/counts?startDate=2020-09-01&endDate=2020-09-30

Body Parameters

None.

Response Information

Resource Description

Summary information about the number of recorded URL actions.

GetBlockedURLsCountsResponse
NameDescriptionTypeAdditional Information
IncludeDeactivated

Value indicating whether URL actions of endpoints that are currently deactivated are included in the counts.

boolean

None.

IncludeHidden

Value indicating whether URL actions of endpoints that are currently hidden are included in the counts.

boolean

None.

StartDate

The start date that was used for the data query.

date

None.

EndDate

The end date that was used for the data query.

date

None.

DatedCounts

List of dated counts of URL actions for the related time periods.

Collection of GetBlockedURLsCountsResponseDatedCount

None.

Sample Response

{
  "IncludeDeactivated": false,
  "IncludeHidden": false,
  "StartDate": "2023-02-07T06:54:29.8814536Z",
  "EndDate": "2023-02-09T06:54:29.8814536Z",
  "DatedCounts": [
    {
      "Date": "2023-02-09T00:00:00Z",
      "Count": 48
    },
    {
      "Date": "2023-02-08T00:00:00Z",
      "Count": 88
    }
  ]
}                    
<GetBlockedURLsCountsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models.BDAPI">
  <DatedCounts>
    <GetBlockedURLsCountsResponseDatedCount>
      <Count>48</Count>
      <Date>2023-02-09T00:00:00Z</Date>
    </GetBlockedURLsCountsResponseDatedCount>
    <GetBlockedURLsCountsResponseDatedCount>
      <Count>88</Count>
      <Date>2023-02-08T00:00:00Z</Date>
    </GetBlockedURLsCountsResponseDatedCount>
  </DatedCounts>
  <EndDate>2023-02-09T06:54:29.8814536Z</EndDate>
  <IncludeDeactivated>false</IncludeDeactivated>
  <IncludeHidden>false</IncludeHidden>
  <StartDate>2023-02-07T06:54:29.8814536Z</StartDate>
</GetBlockedURLsCountsResponse>