Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.keyEvents.list
Stay organized with collections
Save and categorize content based on your preferences.
Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.
HTTP request
GET https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/keyEvents
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The resource name of the parent property. Example: 'properties/123'
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
|
pageToken |
string
A page token, received from a previous keyEvents.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to keyEvents.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response message for keyEvents.list RPC.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"keyEvents": [
{
object (KeyEvent)
}
],
"nextPageToken": string
} |
| Fields |
keyEvents[] |
object (KeyEvent)
The requested Key Events
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
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 2025-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eRetrieves a list of Key Events, which are significant changes or actions within a Google Analytics property.\u003c/p\u003e\n"],["\u003cp\u003eAllows for filtering by parent property and pagination to manage large result sets.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes for access to data.\u003c/p\u003e\n"],["\u003cp\u003eProvides a structured JSON response containing Key Events and pagination details.\u003c/p\u003e\n"],["\u003cp\u003eIncludes links to relevant documentation and code samples for implementation.\u003c/p\u003e\n"]]],["This document details how to list Key Events via an HTTP GET request to `https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/keyEvents`. It requires a `parent` path parameter specifying the property, and optional `pageSize` and `pageToken` query parameters for pagination. The request body must be empty. A successful response returns a JSON structure containing an array of `keyEvents` and a `nextPageToken` for further pagination. Authorization requires specific OAuth scopes.\n"],null,["# Method: properties.keyEvents.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListKeyEventsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/keyEvents`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The resource name of the parent property. Example: 'properties/123' |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |\n| `pageToken` | `string` A page token, received from a previous `keyEvents.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `keyEvents.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for keyEvents.list RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"keyEvents\": [ { object (/analytics/devguides/config/admin/v1/rest/v1beta/properties.keyEvents#KeyEvent) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `keyEvents[]` | `object (`[KeyEvent](/analytics/devguides/config/admin/v1/rest/v1beta/properties.keyEvents#KeyEvent)`)` The requested Key Events |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\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`"]]
