Method: properties.keyEvents.patch

AI-generated Key Takeaways

• This endpoint updates a specific Key Event within a Google Analytics property using an HTTP PATCH request.

• The request requires specifying the Key Event's resource name in the URL path and a updateMask query parameter to indicate the fields to be modified.

• The request body should contain the updated Key Event data in JSON format, and the response will contain the updated Key Event if successful.

• Users need to have the https://www.googleapis.com/auth/analytics.edit OAuth scope to authorize this request.

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

Updates a Key Event.

HTTP request

PATCH https://analyticsadmin.googleapis.com/v1alpha/{keyEvent.name=properties/*/keyEvents/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
keyEvent.name	string Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{keyEvent}

Query parameters

Parameters
updateMask	string (FieldMask format) Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of KeyEvent.

Response body

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

Authorization scopes

Requires the following OAuth scope:

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