Chrome Management API (chromemanagement:v1)

Additions

Methods


• ▼ ▲ chromemanagement.customers.enterprise.securityInsights.queryUrlVisitsBreakdowns

  Scopes :

  • https://www.googleapis.com/auth/chrome.management.securityinsights
  • https://www.googleapis.com/auth/chrome.management.securityinsights.readonly

  Path : v1/{+customer}/enterprise/securityInsights:queryUrlVisitsBreakdowns

  HTTP Method : GET

  Parameters :

  pageSize

  Description : 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.

  Location : query

  Type : integer

  Format : int32

  filter

  Type : string

  Description : 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"`

  Location : query

  metric

  Location : query

  Enum Descriptions :

  • Unspecified URL visits metric. Defaults to URL_VISITS_METRIC_TOTAL_SUSPICIOUS_URL_VISITS.
  • The total number of suspicious URL visits. This is the sum of the high_risk_url_visits, medium_risk_url_visits, and low_risk_url_visits.
  • The number of suspicious URL visits with high risk.
  • The number of suspicious URL visits with medium risk.
  • The number of suspicious URL visits with low risk.

  Type : string

  Enum :

  • 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

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

  fixedTimeRange

  Description : 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.

  Type : string

  Enum :

  • FIXED_TIME_RANGE_UNSPECIFIED
  • FIXED_TIME_RANGE_FOUR_HOURS
  • FIXED_TIME_RANGE_ONE_DAY
  • FIXED_TIME_RANGE_ONE_WEEK
  • FIXED_TIME_RANGE_FOUR_WEEKS

  Location : query

  Enum Descriptions :

  • Unspecified fixed time range. Defaults to FIXED_TIME_RANGE_FOUR_WEEKS.
  • Four hours.
  • One day.
  • One week.
  • Four weeks.

  pageToken

  Type : string

  Description : 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.

  Location : query

  customer

  Pattern : ^customers/[^/]+$

  Location : path

  Type : string

  Description : Required. The customer ID in the format "customers/{customer_id}".

  Required : Yes

  breakdown

  Type : string

  Enum :

  • URL_VISITS_BREAKDOWN_DIMENSION_UNSPECIFIED
  • USER
  • EVENT_DOMAIN

  Location : query

  Enum Descriptions :

  • Unspecified breakdown dimension. Defaults to USER.
  • Breakdown by user.
  • Breakdown by event domain.

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

  Parameter Order : customer

  Description : Returns summaries of URL visits for a given metric and breakdown dimension.

  Flat Path : v1/customers/{customersId}/enterprise/securityInsights:queryUrlVisitsBreakdowns

• ▼ ▲ chromemanagement.customers.enterprise.securityInsights.queryContentTransfers

  HTTP Method : GET

  Parameters :

  customer

  Type : string

  Location : path

  Pattern : ^customers/[^/]+$

  Description : Required. The customer ID in the format "customers/{customer_id}".

  Required : Yes

  filter

  Description : Optional. The filter to apply to the request. For syntax, see AIP-160. Data is not available for events older than 180 days, and may be unavailable or inaccurate for time ranges less than 4 hours. If `event_time` is not specified, results will be returned for the last 30 days. Supported fields for filtering: - `event_time` Supported operators: - `>=` and `<=` for `event_time` Supported conjunctions: - `AND` Example: `event_time >= "2024-01-01T00:00:00Z" AND event_time <= "2024-01-02T00:00:00Z"`

  Location : query

  Type : string

  Parameter Order : customer

  Description : Returns a high-level summary of content transfers for a given customer.

  Scopes :

  • https://www.googleapis.com/auth/chrome.management.securityinsights
  • https://www.googleapis.com/auth/chrome.management.securityinsights.readonly

  Path : v1/{+customer}/enterprise/securityInsights:queryContentTransfers

  Flat Path : v1/customers/{customersId}/enterprise/securityInsights:queryContentTransfers

• ▼ ▲ chromemanagement.customers.enterprise.securityInsights.queryContentTransfersBreakdowns

  Path : v1/{+customer}/enterprise/securityInsights:queryContentTransfersBreakdowns

  Scopes :

  • https://www.googleapis.com/auth/chrome.management.securityinsights
  • https://www.googleapis.com/auth/chrome.management.securityinsights.readonly

  HTTP Method : GET

  Parameters :

  fixedTimeRange

  Description : 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.

  Type : string

  Enum :

  • FIXED_TIME_RANGE_UNSPECIFIED
  • FIXED_TIME_RANGE_FOUR_HOURS
  • FIXED_TIME_RANGE_ONE_DAY
  • FIXED_TIME_RANGE_ONE_WEEK
  • FIXED_TIME_RANGE_FOUR_WEEKS

  Location : query

  Enum Descriptions :

  • Unspecified fixed time range. Defaults to FIXED_TIME_RANGE_FOUR_WEEKS.
  • Four hours.
  • One day.
  • One week.
  • Four weeks.

  pageSize

  Type : integer

  Format : int32

  Description : 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.

  Location : query

  filter

  Description : 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` - `content_category` - `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`, `event_domain`, and `content_category`. - `<=` for `event_time`. Supported conjunctions: - `AND` Example: `user = "testuser" AND event_time <= "2024-01-02T00:00:00Z"`

  Location : query

  Type : string

  metric

  Description : Optional. The metric to return the breakdowns for. Defaults to CONTENT_TRANSFERS_METRIC_TOTAL_TRANSFERS.

  Type : string

  Enum :

  • CONTENT_TRANSFERS_METRIC_UNSPECIFIED
  • CONTENT_TRANSFERS_METRIC_TOTAL_TRANSFERS
  • CONTENT_TRANSFERS_METRIC_TOTAL_UPLOADS
  • CONTENT_TRANSFERS_METRIC_TOTAL_DOWNLOADS
  • CONTENT_TRANSFERS_METRIC_TOTAL_PRINTS
  • CONTENT_TRANSFERS_METRIC_TOTAL_SENSITIVE_TRANSFERS
  • CONTENT_TRANSFERS_METRIC_SENSITIVE_UPLOADS
  • CONTENT_TRANSFERS_METRIC_SENSITIVE_DOWNLOADS
  • CONTENT_TRANSFERS_METRIC_SENSITIVE_PRINTS

  Location : query

  Enum Descriptions :

  • Unspecified content transfers metric. Defaults to CONTENT_TRANSFERS_METRIC_TOTAL_TRANSFERS.
  • The total number of content transfers (sensitive and non-sensitive). This is the sum of the total_uploads, total_downloads, and total_prints.
  • The total number of content uploads (sensitive and non-sensitive).
  • The total number of content downloads (sensitive and non-sensitive).
  • The total number of content prints (sensitive and non-sensitive).
  • The total number of sensitive content transfers. This is the sum of the sensitive_uploads, sensitive_downloads, and sensitive_prints.
  • The number of sensitive content uploads.
  • The number of sensitive content downloads.
  • The number of sensitive content prints.

  customer

  Type : string

  Pattern : ^customers/[^/]+$

  Location : path

  Description : Required. The customer ID in the format "customers/{customer_id}".

  Required : Yes

  breakdown

  Description : Optional. The dimension to break down the content transfers by. Defaults to USER.

  Location : query

  Enum Descriptions :

  • Unspecified breakdown dimension. Defaults to USER.
  • Breakdown by user.
  • Breakdown by event domain.
  • Breakdown by content category.

  Type : string

  Enum :

  • CONTENT_TRANSFERS_BREAKDOWN_DIMENSION_UNSPECIFIED
  • USER
  • EVENT_DOMAIN
  • CONTENT_CATEGORY

  pageToken

  Type : string

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

  Location : query

  Parameter Order : customer

  Description : Returns summaries of content transfers for a given metric and breakdown dimension.

  Flat Path : v1/customers/{customersId}/enterprise/securityInsights:queryContentTransfersBreakdowns

• ▼ ▲ chromemanagement.customers.enterprise.securityInsights.queryUrlVisits

  Scopes :

  • https://www.googleapis.com/auth/chrome.management.securityinsights
  • https://www.googleapis.com/auth/chrome.management.securityinsights.readonly

  Path : v1/{+customer}/enterprise/securityInsights:queryUrlVisits

  Description : Returns a high-level summary of URL visits for a given customer.

  HTTP Method : GET

  Parameters :

  customer

  Type : string

  Location : path

  Pattern : ^customers/[^/]+$

  Description : Required. The customer ID in the format "customers/{customer_id}".

  Required : Yes

  filter

  Description : Optional. The filter to apply to the request. For syntax, see AIP-160. Data is not available for events older than 180 days, and may be unavailable or inaccurate for time ranges less than 4 hours. If `event_time` is not specified, results will be returned for the last 30 days. Supported fields for filtering: - `event_time` Supported operators: - `>=` and `<=` for `event_time` Supported conjunctions: - `AND` Example: `event_time >= "2024-01-01T00:00:00Z" AND event_time <= "2024-01-02T00:00:00Z"`

  Location : query

  Type : string

  Parameter Order : customer

  Flat Path : v1/customers/{customersId}/enterprise/securityInsights:queryUrlVisits