`ga_get_realtime`

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

Check live user activity in a GA4 property right now. Returns current active user count and real-time engagement metrics. Specify property ID (e.g., “123456789”).

Parameters

Name	Type	Required	Description
`property_id`	string	yes	GA4 property ID (numeric)
`dimensions`	array	no	Realtime dimensions (e.g., [“city”, “unifiedScreenName”, “platform”])
`items`	string	no
`metrics`	array	no	Realtime metrics (e.g., [“activeUsers”, “screenPageViews”]). Defaults to [“activeUsers”].
`items`	string	no
`limit`	number	no	Maximum number of rows (default 100)

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_realtime","arguments":{"property_id":"123456789"}}}'

TypeScript (@pipeworx/sdk)

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

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

More examples

{
  "property_id": "123456789",
  "dimensions": [
    "city",
    "platform"
  ],
  "metrics": [
    "activeUsers",
    "screenPageViews"
  ],
  "limit": 50
}

Response shape

Field	Type	Description
`dimensionHeaders`	array	Headers for realtime dimension columns
`metricHeaders`	array	Headers for realtime metric columns
`rows`	array	Real-time data rows with current engagement metrics
`totalsForAllRows`	array	Total values across all rows
`rowCount`	number	Number of rows returned
`kind`	string	API response kind identifier
`error`	string	Error code if connection not established
`message`	string	Error message if connection not established

Full JSON Schema

{
  "type": "object",
  "properties": {
    "dimensionHeaders": {
      "type": "array",
      "description": "Headers for realtime dimension columns",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Dimension name"
          }
        }
      }
    },
    "metricHeaders": {
      "type": "array",
      "description": "Headers for realtime metric columns",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Metric name"
          },
          "type": {
            "type": "string",
            "description": "Data type of metric"
          }
        }
      }
    },
    "rows": {
      "type": "array",
      "description": "Real-time data rows with current engagement metrics",
      "items": {
        "type": "object",
        "properties": {
          "dimensionValues": {
            "type": "array",
            "description": "Dimension values for this row",
            "items": {
              "type": "object"
            }
          },
          "metricValues": {
            "type": "array",
            "description": "Metric values for this row",
            "items": {
              "type": "object"
            }
          }
        }
      }
    },
    "totalsForAllRows": {
      "type": "array",
      "description": "Total values across all rows",
      "items": {
        "type": "object"
      }
    },
    "rowCount": {
      "type": "number",
      "description": "Number of rows returned"
    },
    "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.

ga_get_realtime