Skip to main content
Glama

analyticsadmin.properties.keyEvents.create

Create a Key Event for a Google Analytics property by posting event details such as event name, counting method, and default value; includes dry-run and readonly safety refusal.

Instructions

Creates a Key Event [HTTP POST] — creates or triggers a change; refused under --readonly safety profiles. Returns the API's response resource as JSON — request body is a JSON GoogleAnalyticsAdminV1betaKeyEvent object accepting countingMethod, createTime, custom, defaultValue, deletable, eventName, name; pass it via params or whole via body_file Siblings over the same resource: delete, get, list, 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 where this Key Event will be created. Format: properties/123
dry_runNoReturn the request that would be sent, without sending it.
body_fileNoRead the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON GoogleAnalyticsAdminV1betaKeyEvent object.
request_bodyNoRequest body of type GoogleAnalyticsAdminV1betaKeyEvent: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

NameRequiredDescriptionDefault
nameNo
customNo
deletableNo
eventNameNo
createTimeNo
defaultValueNo
countingMethodNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / body_file / description
      Previous value: -"Read the request body from this file ('-' for stdin) instead of building one from the parameters."New value: +"Read the request body from this file ('-' for stdin) instead of building one from the parameters. The body is a JSON GoogleAnalyticsAdminV1betaKeyEvent object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type GoogleAnalyticsAdminV1betaKeyEvent: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "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"
      +}
  2. Changed3 schema fields changed
    • changedInput schema / properties / parent / description
      Previous value: -"Required. The resource name of the parent property where this Key Event will be created. Format: properties/123"New value: +"[URL path segment] Required. The resource name of the parent property where this Key Event will be created. Format: properties/123"
    • addedInput schema / properties / parent / pattern
      Added value: +"^properties/[^/]+$"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "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"
      +}
  3. First observed

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it declares the mutating POST semantics, warns that the call is refused under --readonly safety profiles, and states that the API response resource is returned as JSON. It stops short of disclosing required OAuth scopes or whether creation is idempotent/irreversible.

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

Conciseness4/5

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

The mutation and read-only caveat are front-loaded in the first clause, which is exactly the right ordering. The single dense paragraph is efficient, though the field enumeration in the middle is a long comma run that could be trimmed since the schema already lists those fields.

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

Completeness5/5

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

For a 6-parameter nested-body mutation with no annotations, the description covers the mutation semantics, safety-profile refusal, request construction paths, body payload type, and sibling routing. Since an output schema exists, the brief return-value note is sufficient and nothing an agent needs to call it correctly is missing.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds value by explaining the params-versus-body_file interaction ('pass it via `params` or whole via `body_file`') and enumerating the GoogleAnalyticsAdminV1betaKeyEvent body fields including countingMethod, which helps the agent decide how to construct the request.

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

Purpose5/5

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

States a specific verb and resource ('Creates a Key Event'), the HTTP method, and explicitly enumerates the sibling operations over the same resource (delete, get, list, patch). An agent can distinguish this from keyEvents.patch without opening either schema.

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

Usage Guidelines4/5

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

It lists the sibling operations over the same resource, which gives the agent a routing map, and notes the --readonly refusal condition. However it never states the positive selection criterion (when to create a new Key Event versus patching an existing one), so the alternative routing is implied rather than spelled out.

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