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/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.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 information about a specific Key Event within a Google Analytics property.\u003c/p\u003e\n"],["\u003cp\u003eAccess Key Event data using the provided HTTP request with necessary path parameters for property and event identification.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, while a successful response returns a KeyEvent object containing the event details.\u003c/p\u003e\n"],["\u003cp\u003eProper authorization is required using specific OAuth scopes to retrieve the Key Event information.\u003c/p\u003e\n"]]],["This describes retrieving a specific Key Event via a `GET` HTTP request to `https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/keyEvents/*}`. The `name` path parameter, formatted as `properties/{property}/keyEvents/{keyEvent}`, is mandatory. The request body must be empty. A successful response contains a `KeyEvent` instance. Authorization requires either `analytics.readonly` or `analytics.edit` OAuth scopes. This operation uses gRPC Transcoding.\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/v1alpha/{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/v1alpha/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`"]]
