GOgoogle
customers

GET /v1/customers/{customersId}/enterprise/securityInsights:queryUrlVisitsBreakdowns

Changed on

Returns summaries of URL visits for a given metric and breakdown dimension. Requires a Chrome Enterprise Premium subscription. If the customer does not have this subscription, query results will be empty.

Request

  • Base URL
    https://chromemanagement.googleapis.com
  • URL
    https://chromemanagement.googleapis.com/v1/customers/{customersId}/enterprise/securityInsights:queryUrlVisitsBreakdowns
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/chrome.management.securityinsights
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/chrome.management.securityinsights
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/chrome.management.securityinsights.readonly
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/chrome.management.securityinsights.readonly

Path parameters

customersIdstring required

Query parameters

breakdown'URL_VISITS_BREAKDOWN_DIMENSION_UNSPECIFIED' | 'USER' | 'EVENT_DOMAIN'

Optional. The dimension to break down the URL visits by. Defaults to USER.

filterstring

Optional. The filter to apply to the request. For syntax, see AIP-160. Data is not available for events older than 180 days or more recent than 48 hours ago. If event_time is not specified, results will end 48 hours ago. Supported fields for filtering: - user - event_domain - event_time Filtering by user or event_domain requires the breakdown dimension to be set to the corresponding value (e.g., you must set breakdown = USER to filter by user). Supported operators: - = for user and event_domain. - <= for event_time. Supported conjunctions: - AND Example: user = "testuser" AND event_time <= "2024-01-02T00:00:00Z"

fixedTimeRange'FIXED_TIME_RANGE_UNSPECIFIED' | 'FIXED_TIME_RANGE_FOUR_HOURS' | 'FIXED_TIME_RANGE_ONE_DAY' | 'FIXED_TIME_RANGE_ONE_WEEK' | 'FIXED_TIME_RANGE_FOUR_WEEKS'

Optional. The fixed time range to return the breakdowns for. Defaults to FIXED_TIME_RANGE_FOUR_WEEKS. Fixed time ranges are used to allow for precomputation and optimize response times.

metric'URL_VISITS_METRIC_UNSPECIFIED' | 'URL_VISITS_METRIC_TOTAL_SUSPICIOUS_URL_VISITS' | 'URL_VISITS_METRIC_HIGH_RISK_URL_VISITS' | 'URL_VISITS_METRIC_MEDIUM_RISK_URL_VISITS' | 'URL_VISITS_METRIC_LOW_RISK_URL_VISITS'

Optional. The metric to return the breakdowns for. Defaults to URL_VISITS_METRIC_TOTAL_SUSPICIOUS_URL_VISITS.

pageSizeinteger

Optional. The maximum number of breakdowns to return. The service may return fewer than this value. If unspecified, at most 50 breakdowns will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageTokenstring

Optional. A page token, received from a previous QueryUrlVisitsBreakdowns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to QueryUrlVisitsBreakdowns must match the call that provided the page token.

Response

Successful response

nextPageTokenstring

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Changes

  • 872a15abbbd0Revision changes
    • info

      the security scope https://www.googleapis.com/auth/chrome.management.securityinsights was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/chrome.management.securityinsights was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/chrome.management.securityinsights.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/chrome.management.securityinsights.readonly was removed from the endpoint's security scheme Oauth2c