Skip to Content
GrowSocialelion API
Read endpoints

Brand overview

One page of state for this brand: each connected network's health and its engagement and publish modes, the daily caps (posts: per network, each separat...

GET | POST /api/v1/get_overview · MCP tool get_overview · scope read

One page of state for this brand: each connected network's health and its engagement and publish modes, the daily caps (posts: per network, each separately; replies, engagements and drafts: per brand) and what was used today, the kill switch, and the workspace's credits: `left` = `allowanceThisPeriod` + `topUps` − `chargedThisPeriod`; `usedThisPeriod` is the month's whole use, and `notChargedThisPeriod` of it was used when no credit was left. Credits, never dollars. Free, from this app's store; no agent run. Connection error sentences come back under `untrusted`.

Scope. Read your own brand data: posts, metrics, runs, the audit trail, the plan, stored mentions and trends. Free, unless you ask a billed network for a fresh read. This endpoint never costs credits.

Arguments

None. Send an empty body or {}.

Request

curl -X POST https://growsocialelion.com/api/v1/get_overview \
  -H "Authorization: Bearer gse_mcp_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

200 with the tool's answer. The shape below is generated from the output schema; real answers can carry more fields.

{
  "status": "string",
  "code": "string",
  "reason": "string",
  "asOf": "string",
  "brand": {
    "brandId": "string",
    "name": "string"
  },
  "halted": {
    "halted": false
  },
  "credits": {
    "left": 1
  },
  "networks": [
    {
      "network": "string",
      "health": "string"
    }
  ],
  "untrusted": {
    "notice": "string"
  }
}

Errors use the shared body. See Errors. The full schema is in the API reference.