ga_get_metadata

Pack: google_analytics · Endpoint: https://gateway.pipeworx.io/google_analytics/mcp

Discover available dimensions and metrics for a GA4 property. Returns field names, descriptions, and data types to build accurate ga_run_report queries.

Parameters

NameTypeRequiredDescription
property_idstringyesGA4 property ID (numeric)

Example call

Arguments

{
  "property_id": "123456789"
}

curl

curl -X POST https://gateway.pipeworx.io/google_analytics/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"ga_get_metadata","arguments":{"property_id":"123456789"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('ga_get_metadata', {
  "property_id": "123456789"
});

Response shape

FieldTypeDescription
dimensionsarrayAvailable dimensions for this GA4 property
metricsarrayAvailable metrics for this GA4 property
kindstringAPI response kind identifier
errorstringError code if connection not established
messagestringError message if connection not established
Full JSON Schema
{
  "type": "object",
  "properties": {
    "dimensions": {
      "type": "array",
      "description": "Available dimensions for this GA4 property",
      "items": {
        "type": "object",
        "properties": {
          "apiName": {
            "type": "string",
            "description": "API name of the dimension"
          },
          "description": {
            "type": "string",
            "description": "Human-readable description"
          },
          "dataType": {
            "type": "string",
            "description": "Data type (STRING, INT64, etc.)"
          },
          "deprecatedApiNames": {
            "type": "array",
            "description": "Deprecated API names for this dimension",
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "metrics": {
      "type": "array",
      "description": "Available metrics for this GA4 property",
      "items": {
        "type": "object",
        "properties": {
          "apiName": {
            "type": "string",
            "description": "API name of the metric"
          },
          "description": {
            "type": "string",
            "description": "Human-readable description"
          },
          "type": {
            "type": "string",
            "description": "Metric type (CURRENCY, TIME_MSEC, etc.)"
          },
          "deprecatedApiNames": {
            "type": "array",
            "description": "Deprecated API names for this metric",
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "kind": {
      "type": "string",
      "description": "API response kind identifier"
    },
    "error": {
      "type": "string",
      "description": "Error code if connection not established"
    },
    "message": {
      "type": "string",
      "description": "Error message if connection not established"
    }
  }
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "google_analytics": {
      "url": "https://gateway.pipeworx.io/google_analytics/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build June 24, 2026