Method: properties.keyEvents.get

  • This document provides a guide on how to retrieve a single Key Event using an HTTP GET request to the specified analyticsadmin.googleapis.com endpoint.

  • The request requires a name path parameter in the format properties/{property}/keyEvents/{keyEvent} to specify the resource name of the Key Event to retrieve.

  • The HTTP request body must be empty, and a successful response body will contain an instance of KeyEvent.

  • To authorize this request, one of the following OAuth scopes is required: https://www.googleapis.com/auth/analytics.readonly or https://www.googleapis.com/auth/analytics.edit.

Retrieve a single Key Event.

HTTP request

GET https://analyticsadmin.googleapis.com/v1beta/{name=properties/*/keyEvents/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{keyEvent} Example: "properties/123/keyEvents/456"

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of KeyEvent.

Authorization scopes

Requires one of the following OAuth scopes:

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