Method: properties.keyEvents.get

AI-generated Key Takeaways

• Retrieve detailed insights about a specific Key Event within your Google Analytics 4 property.

• Access Key Event data through a simple GET request using the provided URL structure.

• Identify the desired Key Event by specifying its resource name in the request path.

• Upon successful retrieval, receive a comprehensive response containing the Key Event details.

• Authorization requires specific OAuth scopes for read or edit access to Analytics data.

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

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