Filters: get

Requires authorization

Returns a filters to which the user has access. Try it now or see an example.

Request

HTTP request

GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/filters/filterId

Parameters

Parameter name Value Description
Path parameters
accountId string Account ID to retrieve filters for.
filterId string Filter ID to retrieve filters for.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/analytics.edit
https://www.googleapis.com/auth/analytics.readonly

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a management.filter resource in the response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library.

/*
 * Note this code assumes you have an authorized Analytics service object.
 * See the Filters Developer Guide for details.
 */

/*
 * This request gets an existing filter.
 */
try {
  Filter filter = analytics.management().filters().get("123456",
      "1223334444").execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

PHP

Uses the PHP client library.

/**
 * Note: This code assumes you have an authorized Analytics service object.
 * See the Filters Developer Guide for details.
 */

// This request gets an existing filter for the authorized user.
try {
  $filter = $analytics->management_filters->get('123456', '7654321');

} catch (apiServiceException $e) {
  print 'There was an Analytics API service error '
      . $e->getCode() . ':' . $e->getMessage();

} catch (apiException $e) {
  print 'There was a general API error '
      . $e->getCode() . ':' . $e->getMessage();
}

Python

Uses the Python client library.

# Note: This code assumes you have an authorized Analytics service object.
# See the Filters Developer Guide for details.

# This request gets an existing filter.
try:
  filters = analytics.management().filters().get(
      accountId='123456',
      filterId='1223334444'
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

JavaScript

Uses the JavaScript client library.

/*
 * Note: This code assumes you have an authorized Analytics client object.
 * See the Filters Developer Guide for details.
 */

/*
 * This request gets an existing filter.
 */
function getFilter() {
  var request = gapi.client.analytics.management.filters.get({
    'accountId': '123456',
    'filterId': '1223334444'
  });
  request.execute(function (response) { // Handle the response. });
}

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.