queryUrlVisits method

Future<GoogleChromeManagementVersionsV1QueryUrlVisitsResponse> queryUrlVisits(
  1. String customer, {
  2. String? filter,
  3. String? $fields,
})

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

Requires a Chrome Enterprise Premium subscription. If the customer does not have this subscription, query results will be empty.

Request parameters:

customer - Required. The customer ID in the format "customers/{customer_id}". Value must have pattern ^customers/\[^/\]+$.

filter - 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"

$fields - Selector specifying which fields to include in a partial response.

Completes with a GoogleChromeManagementVersionsV1QueryUrlVisitsResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<GoogleChromeManagementVersionsV1QueryUrlVisitsResponse>
queryUrlVisits(
  core.String customer, {
  core.String? filter,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    'filter': ?filter == null ? null : [filter],
    'fields': ?$fields == null ? null : [$fields],
  };

  final url_ =
      'v1/' +
      core.Uri.encodeFull('$customer') +
      '/enterprise/securityInsights:queryUrlVisits';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return GoogleChromeManagementVersionsV1QueryUrlVisitsResponse.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}