Skip to content
BrainyShorts Docs
Esc
↑↓navigate↵open⌘Jpreview

Per-channel overview

One call for the health of every connected channel: followers, views and engagement over the period, best post, what is scheduled, recent failures, and when analytics last synced. Numbers come from the last analytics sync; call POST /api/cli/analytics/refresh first for fresher ones. MCP: brainy_get_channel_overview.

GET/api/cli/accounts/overview
Authorization
AuthorizationBearer token (ba_sk_...) · headerrequired

API key from /dashboard/api-keys. Keys expire after 365 days.

or
AuthorizationBearer token (ba_mcp_access_...) · headerrequired

The OAuth access token the hosted MCP server issues (brainy:read for GET routes, brainy:write for everything else). One login serves MCP, the CLI and the desktop app. A token without the needed scope gets 403 Insufficient scope.

Query parameters
daysinteger
min 1 · max 90 · default: 30
Responses
200

OK

periodobject
Show properties
daysinteger
startstring<date-time>
endstring<date-time>
accountsobject[]
Show properties
Array of object
idstring<uuid>

social_account_id for post targets and analytics

platformstring
handlestring | null
token_validboolean

false means the user must reconnect: get a link from POST /api/cli/accounts/connect-links

followersinteger | null

Newest daily snapshot in the period. null when the platform exposes none (LinkedIn), subscribers are hidden, or no sync ran in the period.

followers_changeinteger | null

Newest minus oldest snapshot in the period; null with fewer than two snapshots.

followers_as_ofstring<date> | null
posts_publishedinteger

Posts the platform sync imported with a posted time in the period, including posts made outside Brainy Shorts.

viewsinteger
likesinteger
commentsinteger
sharesinteger
savesinteger
best_postobject | null
Show properties
idstring

Analytics post id; pass it as post_id to GET /api/cli/analytics.

urlstring | null
viewsinteger
scheduled_countinteger

Deliveries to this account that are scheduled or waiting to retry.

next_scheduled_timestring<date-time> | null
failed_count_7dinteger
last_errorstring | null

Error of the most recent failed delivery in the last 7 days.

last_synced_atstring<date-time> | null
analytics_availableboolean

false for article platforms, a token that needs reconnecting, and LinkedIn without the separate analytics connection.

analytics_errorstring | null
totalsobject
truncatedboolean

true when more than 1000 posts were published in the period; the newest 1000 are counted.

400

days is out of range

errorstringrequired
codestring
401

Missing, invalid, expired, or revoked API key

errorstringrequired
codestring
Try it
Server
Authorization
Parameters
Request
curl -X GET "https://www.brainyshorts.com/api/cli/accounts/overview" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "period": {
    "days": 0,
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z"
  },
  "accounts": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "platform": "string",
      "handle": "string",
      "token_valid": true,
      "followers": 0,
      "followers_change": 0,
      "followers_as_of": "2019-08-24",
      "posts_published": 0,
      "views": 0,
      "likes": 0,
      "comments": 0,
      "shares": 0,
      "saves": 0,
      "best_post": {
        "id": "string",
        "url": "string",
        "views": 0
      },
      "scheduled_count": 0,
      "next_scheduled_time": "2019-08-24T14:15:22Z",
      "failed_count_7d": 0,
      "last_error": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "analytics_available": true,
      "analytics_error": "string"
    }
  ],
  "totals": {
    "property1": 0,
    "property2": 0
  },
  "truncated": true
}