Method: properties.keyEvents.get

AI-generated Key Takeaways

• Retrieve detailed information about a specific Key Event within a Google Analytics property.

• Access Key Event data using the provided HTTP request with necessary path parameters for property and event identification.

• The request body should be empty, while a successful response returns a KeyEvent object containing the event details.

• Proper authorization is required using specific OAuth scopes to retrieve the Key Event information.

• HTTP request
• Path parameters
• Request body
• Response body
• Authorization scopes
• Try it!

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