Skip to main content
Glama

analyticsadmin.properties.keyEvents.list

Lists Key Events for a specified Analytics property, returning an empty list when none exist, so you can inspect configured conversion events.

Instructions

Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: create, delete, get, patch.

Input Schema

NameRequiredDescriptionDefault
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
parentYes[URL path segment] Required. The resource name of the parent property. Example: 'properties/123'
dry_runNoReturn the request that would be sent, without sending it.
pageSizeNo[query parameter] Optional. 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 coe
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters.
pageTokenNo[query parameter] Optional. A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provi

Output Schema

NameRequiredDescriptionDefault
keyEventsNo
nextPageTokenNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • changedInput schema / properties / pageSize / description
      Previous value: -"Optional. 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 coe"New value: +"[query parameter] Optional. 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 coe"
    • addedInput schema / properties / pageSize / format
      Added value: +"int32"
    • changedInput schema / properties / pageToken / description
      Previous value: -"Optional. A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provi"New value: +"[query parameter] Optional. A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provi"
    • changedInput schema / properties / parent / description
      Previous value: -"Required. The resource name of the parent property. Example: 'properties/123'"New value: +"[URL path segment] Required. The resource name of the parent property. Example: 'properties/123'"
    • addedInput schema / properties / parent / pattern
      Added value: +"^properties/[^/]+$"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "keyEvents": {
      +      "items": {
      +        "properties": {
      +          "countingMethod": {
      +            "enum": [
      +              "COUNTING_METHOD_UNSPECIFIED",
      +              "ONCE_PER_EVENT",
      +              "ONCE_PER_SESSION"
      +            ],
      +            "type": "string"
      +          },
      +          "createTime": {
      +            "type": "string"
      +          },
      +          "custom": {
      +            "type": "boolean"
      +          },
      +          "defaultValue": {
      +            "properties": {
      +              "currencyCode": {
      +                "type": "string"
      +              },
      +              "numericValue": {
      +                "type": "number"
      +              }
      +            },
      +            "type": "object"
      +          },
      +          "deletable": {
      +            "type": "boolean"
      +          },
      +          "eventName": {
      +            "type": "string"
      +          },
      +          "name": {
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "nextPageToken": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

B3.3/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden; it does disclose two useful traits — the operation is an [HTTP GET] read and returns an empty list rather than an error when nothing exists. It says nothing about permissions, quota/rate limits, ordering of results, or whether pagination is needed to see all Key Events.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose and the empty-list behavior are front-loaded, which is good. But the middle sentence about building request bodies from typed parameters or `body_file` is stock boilerplate and actively distracting on a GET list endpoint that has no request body — it occupies roughly a third of the text without earning its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return shape need not be described, and the schema documents all seven parameters. What is missing is exactly the part structured fields cannot supply: since there are no annotations, the description should confirm read-only safety, auth requirements, and pagination expectations for a 200-item-cap list.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3; the schema already explains parent format, pageSize caps, and pageToken chaining. The description adds only a generic statement about typed parameters overriding the `params` map, which is precedence metadata rather than Key-Events-specific meaning.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence names a specific verb and resource ('Returns a list of Key Events') and scopes it to the parent property, which is enough to separate it from keyEvents.get. The closing note 'Siblings over the same resource: create, delete, get, patch' confirms it is the collection-reader among five, though it names siblings without saying how their behavior differs.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The sibling list implies the alternative (get for a single Key Event) but never states it explicitly, and there is no 'use this when…' guidance or mention of when to prefer keyEvents.get over this list. Pagination guidance lives only in the pageToken schema text, not in the description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools