Skip to main content
Glama

analyticsadmin.properties.customDimensions.get

Fetch a single Google Analytics custom dimension by its properties/{property}/customDimensions/{id} resource name and return it as JSON.

Instructions

Lookup for a single CustomDimension [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: archive, create, list, patch.

Input Schema

NameRequiredDescriptionDefault
nameYes[URL path segment] Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678
queryNoExtra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe.
paramsNoParameter map merged into the request; typed parameters win.
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.

Output Schema

NameRequiredDescriptionDefault
nameNo
scopeNo
descriptionNo
displayNameNo
parameterNameNo
disallowAdsPersonalizationNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • changedInput schema / properties / name / description
      Previous value: -"Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678"New value: +"[URL path segment] Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678"
    • addedInput schema / properties / name / pattern
      Added value: +"^properties/[^/]+/customDimensions/[^/]+$"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "description": {
      +      "type": "string"
      +    },
      +    "disallowAdsPersonalization": {
      +      "type": "boolean"
      +    },
      +    "displayName": {
      +      "type": "string"
      +    },
      +    "name": {
      +      "type": "string"
      +    },
      +    "parameterName": {
      +      "type": "string"
      +    },
      +    "scope": {
      +      "enum": [
      +        "DIMENSION_SCOPE_UNSPECIFIED",
      +        "EVENT",
      +        "USER",
      +        "ITEM"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are provided, so the description carries the burden. It discloses that this is an HTTP GET returning JSON, which establishes the read-only safety profile, but the request-body/body_file discussion is largely irrelevant to a GET and there is no mention of auth scopes, permissions, or error behavior.

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?

The purpose is front-loaded and the sibling list is efficient. However, the clause about building request bodies from typed parameters or body_file is boilerplate noise for a GET lookup that accepts no meaningful body, spending words that don't earn their place.

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

Completeness4/5

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

An output schema exists and the input schema is fully described, so return values and parameters needn't be re-explained. The definition is sufficient to call it correctly; the only gap is absent auth/permission context, which is minor for a simple get.

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 coverage is 100%, so the schema already documents all five parameters, anchoring the baseline at 3. The description adds precedence semantics ('typed flags win over the params map', body_file override) that isn't in the schema, but it is generic template text rather than tool-specific guidance.

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 ('Lookup for a single CustomDimension') and explicitly names the sibling operations over the same resource (archive, create, list, patch), so an agent can distinguish get from list without opening a 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?

Naming the sibling set (archive/create/list/patch) routes the agent away from those when fetching one item, giving clear context. It does not explicitly state the when-to-use condition (e.g. 'use list to enumerate, get when you have a name'), so it falls short of full 5-level guidance.

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