get_dashboard_overview | SocialCRM API Docs

Get a high-level dashboard overview for the company: average visibility score, brand count, open issues, and unread notifications. A good first call to understand overall status.

Parameters

This tool takes no parameters. companyId is auto-injected from your API key.

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_dashboard_overview",
      "arguments": {}
    }
  }'

Example Response

Parsed from result.content[0].text:

{
  "latestScore": 72,
  "scoreChange": null,
  "brandCount": 3,
  "openIssues": 7,
  "criticalIssues": 2,
  "unreadNotifications": 4,
  "hasBrands": true,
  "hasScores": true,
  "hasIssues": true
}

Output Schema

Field	Type	Description
`latestScore`	number \| null	Average visibility score across all active brands.
`scoreChange`	number \| null	Average score change (may be `null` if trend data is unavailable).
`brandCount`	number	Number of active (non-archived) brand profiles.
`openIssues`	number	Total open or in-progress visibility issues.
`criticalIssues`	number	Number of critical-severity issues.
`unreadNotifications`	number	Count of unread notifications.
`hasBrands`	boolean	`true` if the company has at least one brand profile.
`hasScores`	boolean	`true` if at least one brand has a calculated score.
`hasIssues`	boolean	`true` if there are open issues.

Notes

Use hasBrands, hasScores, and hasIssues to detect empty states and guide the user through onboarding.
For per-brand detail, follow up with get_ai_visibility_score for a specific brand.