Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.keyEvents.get
Stay organized with collections
Save and categorize content based on your preferences.
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.readonlyhttps://www.googleapis.com/auth/analytics.edit
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eRetrieve detailed insights about a specific Key Event within your Google Analytics 4 property.\u003c/p\u003e\n"],["\u003cp\u003eAccess Key Event data through a simple GET request using the provided URL structure.\u003c/p\u003e\n"],["\u003cp\u003eIdentify the desired Key Event by specifying its resource name in the request path.\u003c/p\u003e\n"],["\u003cp\u003eUpon successful retrieval, receive a comprehensive response containing the Key Event details.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires specific OAuth scopes for read or edit access to Analytics data.\u003c/p\u003e\n"]]],["This document details retrieving a Key Event via a `GET` HTTP request to `https://analyticsadmin.googleapis.com/v1beta/{name=properties/*/keyEvents/*}`. The request requires a `name` path parameter specifying the Key Event's resource name (e.g., \"properties/123/keyEvents/456\"). The request body must be empty. A successful response returns a `KeyEvent` instance. Authorization requires either the `analytics.readonly` or `analytics.edit` OAuth scope. The document also uses gRPC Transcoding syntax.\n"],null,["# Method: properties.keyEvents.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieve a single Key Event.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1beta/{name=properties/*/keyEvents/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{keyEvent} Example: \"properties/123/keyEvents/456\" |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [KeyEvent](/analytics/devguides/config/admin/v1/rest/v1beta/properties.keyEvents#KeyEvent).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/analytics.readonly`\n- `https://www.googleapis.com/auth/analytics.edit`"]]
