getSourcesHealth

GET

/sources/health

const url = 'http://localhost:8080/api/v1/sources/health';
const options = {method: 'GET', headers: {cookie: 'hs_session=<hs_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/sources/health \
  --cookie hs_session=<hs_session>

Authorizations

cookieAuth
bearerAuth

Responses

200

Per-platform source health.

application/json

object

platforms

required

Array<object>

object

platform

required

string

Allowed values: instagram facebook line wechat bluesky x douyin xiaohongshu truthsocial

tier

required

string

Allowed values: server agent closed

accounts

required

integer

required

integer

stale

required

integer

needsAgent

required

integer

loginRequired

required

integer

error

required

integer

lastSuccessAt

One of:

string
null

string format: date-time

Examples

seed

Derived from fixtures/seed.json.

{
  "platforms": [
    {
      "accounts": 1,
      "error": 0,
      "lastSuccessAt": "2026-10-17T08:30:00.000Z",
      "loginRequired": 0,
      "needsAgent": 0,
      "ok": 1,
      "platform": "bluesky",
      "stale": 0,
      "tier": "server"
    },
    {
      "accounts": 1,
      "error": 0,
      "lastSuccessAt": null,
      "loginRequired": 0,
      "needsAgent": 1,
      "ok": 0,
      "platform": "douyin",
      "stale": 0,
      "tier": "agent"
    },
    {
      "accounts": 1,
      "error": 0,
      "lastSuccessAt": "2026-10-17T07:00:00.000Z",
      "loginRequired": 0,
      "needsAgent": 0,
      "ok": 1,
      "platform": "facebook",
      "stale": 0,
      "tier": "agent"
    },
    {
      "accounts": 2,
      "error": 0,
      "lastSuccessAt": "2026-10-17T08:00:00.000Z",
      "loginRequired": 0,
      "needsAgent": 0,
      "ok": 2,
      "platform": "instagram",
      "stale": 0,
      "tier": "agent"
    },
    {
      "accounts": 1,
      "error": 0,
      "lastSuccessAt": null,
      "loginRequired": 0,
      "needsAgent": 0,
      "ok": 0,
      "platform": "line",
      "stale": 0,
      "tier": "closed"
    },
    {
      "accounts": 1,
      "error": 0,
      "lastSuccessAt": "2026-10-17T08:00:00.000Z",
      "loginRequired": 0,
      "needsAgent": 0,
      "ok": 1,
      "platform": "truthsocial",
      "stale": 0,
      "tier": "server"
    },
    {
      "accounts": 1,
      "error": 0,
      "lastSuccessAt": null,
      "loginRequired": 0,
      "needsAgent": 0,
      "ok": 0,
      "platform": "wechat",
      "stale": 0,
      "tier": "closed"
    },
    {
      "accounts": 2,
      "error": 0,
      "lastSuccessAt": "2026-10-13T09:00:00.000Z",
      "loginRequired": 0,
      "needsAgent": 0,
      "ok": 0,
      "platform": "x",
      "stale": 1,
      "tier": "agent"
    },
    {
      "accounts": 1,
      "error": 0,
      "lastSuccessAt": "2026-10-17T04:00:00.000Z",
      "loginRequired": 0,
      "needsAgent": 0,
      "ok": 1,
      "platform": "xiaohongshu",
      "stale": 0,
      "tier": "agent"
    }
  ]
}