Skip to main content
Glama

analyticsadmin.properties.customMetrics.create

Creates a CustomMetric on a Google Analytics property to track event-scoped metrics. Send the metric definition as JSON to register it for reporting.

Instructions

Creates a CustomMetric [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 GoogleAnalyticsAdminV1betaCustomMetric object accepting description, displayName, measurementUnit, name, parameterName, restrictedMetricType, scope; pass it via params or whole via body_file Siblings over the same resource: archive, 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. Example format: properties/1234
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 GoogleAnalyticsAdminV1betaCustomMetric object.
request_bodyNoRequest body of type GoogleAnalyticsAdminV1betaCustomMetric: pass it via `params` (merged into the built body) or whole via `body_file`.

Output Schema

NameRequiredDescriptionDefault
nameNo
scopeNo
descriptionNo
displayNameNo
parameterNameNo
measurementUnitNo
restrictedMetricTypeNo

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 GoogleAnalyticsAdminV1betaCustomMetric object."
    • addedInput schema / properties / request_body
      Added value: +{
      +  "description": "Request body of type GoogleAnalyticsAdminV1betaCustomMetric: pass it via `params` (merged into the built body) or whole via `body_file`.",
      +  "properties": {
      +    "description": {
      +      "type": "string"
      +    },
      +    "displayName": {
      +      "type": "string"
      +    },
      +    "measurementUnit": {
      +      "enum": [
      +        "MEASUREMENT_UNIT_UNSPECIFIED",
      +        "STANDARD",
      +        "CURRENCY",
      +        "FEET",
      +        "METERS",
      +        "KILOMETERS",
      +        "MILES",
      +        "MILLISECONDS",
      +        "SECONDS",
      +        "MINUTES",
      +        "HOURS"
      +      ],
      +      "type": "string"
      +    },
      +    "name": {
      +      "type": "string"
      +    },
      +    "parameterName": {
      +      "type": "string"
      +    },
      +    "restrictedMetricType": {
      +      "items": {
      +        "enum": [
      +          "RESTRICTED_METRIC_TYPE_UNSPECIFIED",
      +          "COST_DATA",
      +          "REVENUE_DATA"
      +        ],
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "scope": {
      +      "enum": [
      +        "METRIC_SCOPE_UNSPECIFIED",
      +        "EVENT"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed3 schema fields changed
    • changedInput schema / properties / parent / description
      Previous value: -"Required. Example format: properties/1234"New value: +"[URL path segment] Required. Example format: properties/1234"
    • addedInput schema / properties / parent / pattern
      Added value: +"^properties/[^/]+$"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "description": {
      +      "type": "string"
      +    },
      +    "displayName": {
      +      "type": "string"
      +    },
      +    "measurementUnit": {
      +      "enum": [
      +        "MEASUREMENT_UNIT_UNSPECIFIED",
      +        "STANDARD",
      +        "CURRENCY",
      +        "FEET",
      +        "METERS",
      +        "KILOMETERS",
      +        "MILES",
      +        "MILLISECONDS",
      +        "SECONDS",
      +        "MINUTES",
      +        "HOURS"
      +      ],
      +      "type": "string"
      +    },
      +    "name": {
      +      "type": "string"
      +    },
      +    "parameterName": {
      +      "type": "string"
      +    },
      +    "restrictedMetricType": {
      +      "items": {
      +        "enum": [
      +          "RESTRICTED_METRIC_TYPE_UNSPECIFIED",
      +          "COST_DATA",
      +          "REVENUE_DATA"
      +        ],
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "scope": {
      +      "enum": [
      +        "METRIC_SCOPE_UNSPECIFIED",
      +        "EVENT"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations present, the description carries the full burden and does real work: it discloses that this is a mutating POST, that it is blocked under --readonly profiles, that it returns the API response resource as JSON, and that the body may be supplied either merged via `params` or wholesale via `body_file`. It stops short of stating required auth scope or duplicate-name behavior.

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 purpose is front-loaded in the first clause and there is no filler prose, but the long em-dash chain is dense and the seven-field enumeration duplicates what the schema already lists, which is the one stretch that does not earn 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 the return-value gloss is optional and adequately covered. For a 6-parameter mutation tool with no annotations, however, the description omits the practical prerequisites an agent needs before calling it — permissions/scope, whether a duplicate displayName is rejected, and whether the created metric is immediately usable.

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 description re-enumerates the body fields (description, displayName, measurementUnit, name, parameterName, restrictedMetricType, scope) and the params/body_file routing, both of which are already documented in the schema, so it adds little meaning beyond structured data.

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 CustomMetric under a GA4 property) and explicitly names the sibling operations over the same resource (archive, get, list, patch), so an agent can place it in the CRUD set without opening another schema. The '[HTTP POST]' marker reinforces the write nature.

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?

It lists the sibling operations over the same resource but never says when to choose create over patch, or what preconditions apply (e.g. metric must not already exist). The only operative guidance is the negative one: it 'is refused under --readonly safety profiles.' Usage is implied rather than routed.

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