--- name: google-analytics description: | Google Analytics API integration with managed OAuth. This skill includes two separate APIs: the Admin API (write-capable — can create, update, and delete accounts, properties, and data streams) and the Data API (read-only — runs reports on sessions, users, page views, and conversions). Prefer the Data API connection for reporting-only tasks. Use the Admin API only when administrative changes are explicitly needed. All Admin API write operations require explicit user approval with specific resource identifiers before execution. For other third party apps, use the api-gateway skill (https://clawhub.ai/byungkyu/api-gateway). compatibility: Requires network access and valid Maton API key metadata: author: maton version: "1.0" clawdbot: emoji: 🧠 requires: env: - MATON_API_KEY --- # Google Analytics Access Google Analytics with managed OAuth authentication. This skill covers both the Admin API (manage accounts, properties, data streams) and the Data API (run reports on metrics). ## Quick Start ```bash # List account summaries (Admin API) python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://api.maton.ai/google-analytics-admin/v1beta/accountSummaries') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF # Run a report (Data API) python <<'EOF' import urllib.request, os, json data = json.dumps({'dateRanges': [{'startDate': '30daysAgo', 'endDate': 'today'}], 'dimensions': [{'name': 'city'}], 'metrics': [{'name': 'activeUsers'}]}).encode() req = urllib.request.Request('https://api.maton.ai/google-analytics-data/v1beta/properties/{propertyId}:runReport', data=data, method='POST') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Content-Type', 'application/json') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ``` ## Base URLs **Data API** (read-only — run reports): ``` https://api.maton.ai/google-analytics-data/{native-api-path} ``` **Admin API** (write-capable — manage accounts, properties, data streams): ``` https://api.maton.ai/google-analytics-admin/{native-api-path} ``` Prefer the Data API for reporting tasks. Use the Admin API only when the user explicitly needs to create, update, or delete analytics configuration. Admin API mutations are high-impact — changes to properties and data streams affect analytics data collection. Maton proxies requests to `analyticsadmin.googleapis.com` and `analyticsdata.googleapis.com` and automatically injects your OAuth token. ## Authentication All requests require the Maton API key in the Authorization header: ``` Authorization: Bearer $MATON_API_KEY ``` **Environment Variable:** Set your API key as `MATON_API_KEY`: ```bash export MATON_API_KEY="YOUR_API_KEY" ``` ### Getting Your API Key 1. Sign in or create an account at [maton.ai](https://maton.ai) 2. Go to [maton.ai/settings](https://maton.ai/settings) 3. Copy your API key ## Connection Management Manage your Google OAuth connections at `https://api.maton.ai`. **Important:** The Admin API and Data API use separate connections: - `google-analytics-admin` - Required for Admin API endpoints (manage accounts, properties, data streams) - `google-analytics-data` - Required for Data API endpoints (run reports) Create the connection(s) you need based on which API you want to use. ### List Connections ```bash # List Admin API connections python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://api.maton.ai/connections?app=google-analytics-admin&status=ACTIVE') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF # List Data API connections python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://api.maton.ai/connections?app=google-analytics-data&status=ACTIVE') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ``` ### Create Connection ```bash # Create Admin API connection (for managing accounts, properties, data streams) python <<'EOF' import urllib.request, os, json data = json.dumps({'app': 'google-analytics-admin'}).encode() req = urllib.request.Request('https://api.maton.ai/connections', data=data, method='POST') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Content-Type', 'application/json') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF # Create Data API connection (for running reports) python <<'EOF' import urllib.request, os, json data = json.dumps({'app': 'google-analytics-data'}).encode() req = urllib.request.Request('https://api.maton.ai/connections', data=data, method='POST') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Content-Type', 'application/json') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ``` ### Get Connection ```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://api.maton.ai/connections/{connection_id}') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ``` **Response:** ```json { "connection": { "connection_id": "{connection_id}", "status": "ACTIVE", "creation_time": "2025-12-08T07:20:53.488460Z", "last_updated_time": "2026-01-31T20:03:32.593153Z", "url": "https://connect.maton.ai/?session_token=...", "app": "google-analytics-admin", "metadata": {} } } ``` Open the returned `url` in a browser to complete OAuth authorization. ### Delete Connection ```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://api.maton.ai/connections/{connection_id}', method='DELETE') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ``` ### Specifying Connection If you have multiple Google Analytics connections, specify which one to use with the `Maton-Connection` header: ```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://api.maton.ai/google-analytics-admin/v1beta/accountSummaries') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Maton-Connection', '{connection_id}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ``` If you have multiple connections, always include this header to ensure requests go to the intended account. ## Security & Permissions - **Prefer the Data API connection for reporting tasks.** The Data API is read-only and cannot modify analytics configuration. Only create an Admin API connection when the user explicitly needs administrative changes. - Access is scoped to properties, data streams, reports, and analytics data within the connected Google Analytics account. Revoke unused connections promptly — especially Admin API connections when administrative work is complete. - **Default to read-only operations.** Always start by listing or retrieving resources to confirm account, property, and data stream identifiers before proposing any changes. - **All Admin API write operations require explicit user approval with specific identifiers.** Before executing any POST, PATCH, or DELETE call: 1. Retrieve and display the target resource (property name/ID, data stream name, account) so the user can verify. 2. Clearly describe the intended effect (e.g., "This will delete data stream 'Web - example.com' (ID: 123456) from property 'My Site' — this will stop data collection"). 3. Wait for explicit user confirmation before proceeding. - **Admin API changes are high-impact and may be irreversible.** Deleting properties or data streams stops data collection permanently. Modifying property settings can affect reporting accuracy. These actions must include a summary of consequences and require confirmation. ## Admin API Reference ### Accounts ```bash GET /google-analytics-admin/v1beta/accounts GET /google-analytics-admin/v1beta/accounts/{accountId} GET /google-analytics-admin/v1beta/accountSummaries ``` ### Properties ```bash GET /google-analytics-admin/v1beta/properties?filter=parent:accounts/{accountId} GET /google-analytics-admin/v1beta/properties/{propertyId} ``` #### Create Property ```bash POST /google-analytics-admin/v1beta/properties Content-Type: application/json { "parent": "accounts/{accountId}", "displayName": "My New Property", "timeZone": "America/Los_Angeles", "currencyCode": "USD" } ``` ### Data Streams ```bash GET /google-analytics-admin/v1beta/properties/{propertyId}/dataStreams ``` #### Create Web Data Stream ```bash POST /google-analytics-admin/v1beta/properties/{propertyId}/dataStreams Content-Type: application/json { "type": "WEB_DATA_STREAM", "displayName": "My Website", "webStreamData": {"defaultUri": "https://example.com"} } ``` ### Custom Dimensions ```bash GET /google-analytics-admin/v1beta/properties/{propertyId}/customDimensions ``` #### Create Custom Dimension ```bash POST /google-analytics-admin/v1beta/properties/{propertyId}/customDimensions Content-Type: application/json { "parameterName": "user_type", "displayName": "User Type", "scope": "USER" } ``` ### Conversion Events ```bash GET /google-analytics-admin/v1beta/properties/{propertyId}/conversionEvents POST /google-analytics-admin/v1beta/properties/{propertyId}/conversionEvents ``` ## Data API Reference ### Run Report ```bash POST /google-analytics-data/v1beta/properties/{propertyId}:runReport Content-Type: application/json { "dateRanges": [{"startDate": "30daysAgo", "endDate": "today"}], "dimensions": [{"name": "city"}], "metrics": [{"name": "activeUsers"}] } ``` ### Run Realtime Report ```bash POST /google-analytics-data/v1beta/properties/{propertyId}:runRealtimeReport Content-Type: application/json { "dimensions": [{"name": "country"}], "metrics": [{"name": "activeUsers"}] } ``` ### Batch Run Reports ```bash POST /google-analytics-data/v1beta/properties/{propertyId}:batchRunReports Content-Type: application/json { "requests": [ { "dateRanges": [{"startDate": "7daysAgo", "endDate": "today"}], "dimensions": [{"name": "country"}], "metrics": [{"name": "sessions"}] } ] } ``` ### Get Metadata ```bash GET /google-analytics-data/v1beta/properties/{propertyId}/metadata ``` ## Common Report Examples ### Page Views by Page ```json { "dateRanges": [{"startDate": "30daysAgo", "endDate": "today"}], "dimensions": [{"name": "pagePath"}], "metrics": [{"name": "screenPageViews"}], "orderBys": [{"metric": {"metricName": "screenPageViews"}, "desc": true}], "limit": 10 } ``` ### Users by Country ```json { "dateRanges": [{"startDate": "30daysAgo", "endDate": "today"}], "dimensions": [{"name": "country"}], "metrics": [{"name": "activeUsers"}, {"name": "sessions"}] } ``` ### Traffic Sources ```json { "dateRanges": [{"startDate": "30daysAgo", "endDate": "today"}], "dimensions": [{"name": "sessionSource"}, {"name": "sessionMedium"}], "metrics": [{"name": "sessions"}, {"name": "conversions"}] } ``` ## Common Dimensions - `date`, `country`, `city`, `deviceCategory` - `pagePath`, `pageTitle`, `landingPage` - `sessionSource`, `sessionMedium`, `sessionCampaignName` ## Common Metrics - `activeUsers`, `newUsers`, `sessions` - `screenPageViews`, `bounceRate`, `averageSessionDuration` - `conversions`, `eventCount` ## Date Formats - Relative: `today`, `yesterday`, `7daysAgo`, `30daysAgo` - Absolute: `2026-01-01` ## Code Examples ### JavaScript ```javascript // List account summaries (Admin API) const accounts = await fetch( 'https://api.maton.ai/google-analytics-admin/v1beta/accountSummaries', { headers: { 'Authorization': `Bearer ${process.env.MATON_API_KEY}` } } ); // Run a report (Data API) const report = await fetch( 'https://api.maton.ai/google-analytics-data/v1beta/properties/123456:runReport', { method: 'POST', headers: { 'Content-Type': 'application/json', 'Authorization': `Bearer ${process.env.MATON_API_KEY}` }, body: JSON.stringify({ dateRanges: [{ startDate: '30daysAgo', endDate: 'today' }], dimensions: [{ name: 'country' }], metrics: [{ name: 'activeUsers' }] }) } ); ``` ### Python ```python import os import requests # List account summaries (Admin API) accounts = requests.get( 'https://api.maton.ai/google-analytics-admin/v1beta/accountSummaries', headers={'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}'} ) # Run a report (Data API) report = requests.post( 'https://api.maton.ai/google-analytics-data/v1beta/properties/123456:runReport', headers={'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}'}, json={ 'dateRanges': [{'startDate': '30daysAgo', 'endDate': 'today'}], 'dimensions': [{'name': 'country'}], 'metrics': [{'name': 'activeUsers'}] } ) ``` ## Notes - GA4 properties only (Universal Analytics not supported) - Property IDs are numeric (e.g., `properties/521310447`) - Use `accountSummaries` to quickly list all accessible properties - Use `updateMask` for PATCH requests in Admin API - Use metadata endpoint to discover available dimensions/metrics - IMPORTANT: When using curl commands, use `curl -g` when URLs contain brackets (`fields[]`, `sort[]`, `records[]`) to disable glob parsing - IMPORTANT: When piping curl output to `jq` or other commands, environment variables like `$MATON_API_KEY` may not expand correctly in some shell environments. You may get "Invalid API key" errors when piping. ## Error Handling | Status | Meaning | |--------|---------| | 400 | Missing Google Analytics connection | | 401 | Invalid or missing Maton API key | | 429 | Rate limited (10 req/sec per account) | | 4xx/5xx | Passthrough error from Google Analytics API | ### Troubleshooting: Invalid API Key **When you receive a "Invalid API key" error, ALWAYS follow these steps before concluding there is an issue:** 1. Check that the `MATON_API_KEY` environment variable is set: ```bash echo $MATON_API_KEY ``` 2. Verify the API key is valid by listing connections: ```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://api.maton.ai/connections') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ``` ### Troubleshooting: Invalid App Name 1. Ensure your URL path starts with the correct app name: - For Admin API: use `google-analytics-admin` - For Data API: use `google-analytics-data` Examples: - Correct: `https://api.maton.ai/google-analytics-admin/v1beta/accountSummaries` - Correct: `https://api.maton.ai/google-analytics-data/v1beta/properties/123456:runReport` - Incorrect: `https://api.maton.ai/analytics/v1beta/accountSummaries` ## Resources - [Admin API Overview](https://developers.google.com/analytics/devguides/config/admin/v1) - [Accounts](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1beta/accounts) - [Properties](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1beta/properties) - [Data Streams](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1beta/properties.dataStreams) - [Data API Overview](https://developers.google.com/analytics/devguides/reporting/data/v1) - [Run Report](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport) - [Realtime Report](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runRealtimeReport) - [Maton Community](https://discord.com/invite/dBfFAcefs2) - [Maton Support](mailto:support@maton.ai)