Tool Reference

get_platform_metrics

Get visibility and engagement metrics across AI platforms.

Get visibility and engagement metrics across AI platforms for a brand.

Parameters

Parameter Type Required Description
brandId string Yes The brand ID (UUID) or brand name (e.g., "Ace Auto Repair")

Example Request

curl -X POST https://socialcrm.com/api/mcp-app \
  -H "Authorization: Bearer sk_live_YOUR_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d '{
    "jsonrpc": "2.0",
    "id": "1",
    "method": "tools/call",
    "params": {
      "name": "get_platform_metrics",
      "arguments": {
        "brandId": "brand_abc123"
      }
    }
  }'

Example Response

Parsed from result.content[0].text:

[
  {
    "platform": "chatgpt",
    "mentionCount": 42,
    "sentimentScore": 0.75,
    "visibilityScore": 68,
    "lastUpdated": "2026-02-17T15:30:00.000Z"
  },
  {
    "platform": "claude",
    "mentionCount": 28,
    "sentimentScore": 0.82,
    "visibilityScore": 55,
    "lastUpdated": "2026-02-17T15:30:00.000Z"
  },
  {
    "platform": "gemini",
    "mentionCount": 15,
    "sentimentScore": 0.60,
    "visibilityScore": 40,
    "lastUpdated": "2026-02-16T10:00:00.000Z"
  }
]

Output Schema

Returns an array of platform metric objects:

Field Type Description
platform string AI platform name (e.g., "chatgpt", "claude", "gemini", "perplexity")
mentionCount number Total number of brand mentions detected
sentimentScore number Sentiment score from -1 (negative) to 1 (positive)
visibilityScore number Visibility score from 0 to 100
lastUpdated string ISO 8601 timestamp of when metrics were last computed

Notes

  • Metrics are aggregated from agent run results. If no monitoring agents have run for this brand, an empty array is returned.
  • Run an AI Shop Checkup workflow to generate fresh metrics across all platforms.