Skip to main content
Glama

analyticsadmin.properties.customDimensions.list

Lists custom dimensions on a Google Analytics property, returning JSON with pagination support.

Instructions

Lists CustomDimensions on a property [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, 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. Example format: properties/1234
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 coer
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 `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameter

Output Schema

NameRequiredDescriptionDefault
nextPageTokenNo
customDimensionsNo

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 coer"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 coer"
    • addedInput schema / properties / pageSize / format
      Added value: +"int32"
    • changedInput schema / properties / pageToken / description
      Previous value: -"Optional. A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameter"New value: +"[query parameter] Optional. A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameter"
    • 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": {
      +    "customDimensions": {
      +      "items": {
      +        "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"
      +      },
      +      "type": "array"
      +    },
      +    "nextPageToken": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.6/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 full burden. It usefully signals '[HTTP GET]' and that a JSON resource is returned, but says nothing about required permissions, pagination behavior, or result ordering — significant gaps for a 7-parameter listing endpoint.

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 first sentence is front-loaded and precise, but the second sentence is generic boilerplate about request bodies being built from typed parameters or `body_file` — largely irrelevant for a GET listing — which dilutes the definition.

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 so return values needn't be explained, and all 7 parameters are documented in the schema. Sibling routing is present; only permission and pagination nuance is missing, which is minor given the structured coverage.

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 parent, pageSize and pageToken are already documented. The description adds a little context about typed flags winning over the `params` map and `body_file`, which is a marginal value-add over the schema baseline.

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 with its scope: 'Lists CustomDimensions on a property'. It also names the sibling operations over the same resource (archive, create, get, patch), so an agent can distinguish list from get 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 Guidelines3/5

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

The sibling list implies routing (use list to enumerate, get for a single record, patch to modify), but the description never states a when-to-use condition or any prerequisite. Usage is only implied rather than explicit.

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