Googleanalytics MCP Server

🚀 Google Analytics Data API MCP Server

This is a Model Context Protocol (MCP) server for interacting with the Google Analytics Data API v1. The server offers tools and resources for querying Google Analytics data, managing audiences, and accessing metadata.

🚀 Quick Start

This MCP server provides an interface to interact with Google Analytics Data API v1. With it, you can query data, manage audiences, and access metadata.

✨ Features

• Run standard reports and pivot table reports.
• Batch process reports.
• Access metadata for dimensions and metrics.
• Create, list, update, and delete audiences.
• Check compatibility between dimensions and metrics.
• Provide comprehensive resource endpoints to explore GA data.

📦 Installation

Prerequisites

• Node.js 14 or higher.
• A Google Analytics 4 account property.
• A Google Cloud service account with appropriate permissions.

Steps

1. Clone this repository.
2. Install dependencies:

   npm install
   

3. Create a .env file based on .env.example and fill in your Google Analytics credentials:

   GOOGLE_CLIENT_EMAIL=your-service-account-email@project-id.iam.gserviceaccount.com
   GOOGLE_PRIVATE_KEY=your-private-key
   DEFAULT_PROPERTY_ID=properties/123456789
   

💻 Usage Examples

Run the Server

npm start

Test with the MCP Check Tool

npm run inspect

Available Tools

• runReport: Run a standard report of Google Analytics data.
• batchRunReports: Run multiple reports in batch.
• runPivotReport: Run a report with a pivot table.
• batchRunPivotReports: Run reports with pivot tables in batch.
• getMetadata: Get metadata for dimensions and metrics.
• checkCompatibility: Check compatibility between dimensions and metrics.
• createAudience: Create a new audience.
• listAudiences: List all audiences under a property.
• getAudience: Get detailed information about a specific audience.
• deleteAudience: Delete an audience.
• updateAudience: Update an existing audience.

Available Resources

• ga://property/{propertyId}: Get property information.
• ga://report/{propertyId}/{reportType}/{dimensions}/{metrics}/{startDate}/{endDate}: Generate a report.
• ga://metadata: Get API metadata.
• ga://dimensions: Browse dimensions by category.
• ga://dimensions/{category}: Get all dimensions for a specific category.
• ga://metrics: Browse metrics by category.
• ga://metrics/{category}: Get all metrics for a specific category.
• ga://audiences/{propertyId}: List all audiences under a property.
• ga://audiences/{propertyId}/{audienceId}: Get detailed information about a specific audience.

Basic Usage

Run a Basic Report

{
  "propertyId": "properties/123456789",
  "dateRanges": [
    {
      "startDate": "7daysAgo",
      "endDate": "yesterday"
    }
  ],
  "dimensions": [
    {
      "name": "country"
    },
    {
      "name": "deviceCategory"
    }
  ],
  "metrics": [
    {
      "name": "activeUsers"
    },
    {
      "name": "sessions"
    }
  ]
}

Create an Audience

{
  "propertyId": "properties/123456789",
  "displayName": "High Value Users",
  "description": "Users who have completed a purchase",
  "membershipDurationDays": 30,
  "filterClauses": [
    {
      "filterExpression": {
        "andGroup": {
          "expressions": [
            {
              "filter": {
                "fieldName": "eventName",
                "stringFilter": {
                  "value": "purchase",
                  "matchType": "EXACT"
                }
              }
            }
          ]
        }
      }
    }
  ]
}

📄 License

[Fill in the license information here]

Contributors

[List the contributors here]

Version History

[Add the version history here]