Method: properties.keyEvents.get

  • This document provides details on how to retrieve a single Key Event using an HTTP GET request.

  • The request uses a specific URL format with a required name path parameter that identifies the Key Event.

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

  • Authorization requires either the analytics.readonly or analytics.edit OAuth scope.

Retrieve a single Key Event.

HTTP request

GET https://analyticsadmin.googleapis.com/v1alpha/{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