Accounts

Check account health

Changed on

Returns detailed health info for a specific account including token status, permissions, and recommendations.

A failing or stalled analytics sync (see analyticsSync) raises a healthy account to at least warning.

On Facebook, Instagram and Threads the token is also probed live. A probe Meta refuses with a dead-token error sets tokenStatus.valid to false and names Meta's code, subcode and fbtrace in issues, unless an analytics sync succeeded with that token in the last six hours: then the token stays valid and issues reports the probe as inconclusive, since Meta answers a transient 190 to live tokens now and then. Neither verdict disconnects the account; that happens only when a real operation fails, and account.disconnected is sent.

For WhatsApp accounts the response also includes platformConnection, a live probe of the Meta link behind the channel (the same read as GET /v1/whatsapp/number-info). The OAuth token can be perfectly valid while Meta refuses to serve the phone-number object (for example after a phone-side coexistence disconnect), so tokenStatus alone is not a liveness signal for WhatsApp. When the Meta link is dead, platformConnection.status is disconnected and the overall status is error. When Meta reports that the number's inbound message webhook does not reach Zernio, platformConnection.inboundWebhookSubscribed is false, an entry is added to issues, and the overall status is at least warning.

For the standalone ads connections (googleads, redditads) a connection that cannot serve requests until a fresh OAuth repairs it adds an entry to issues and a recommendation to call GET /v1/connect/{platform}/ads, whose authUrl reconnects the same account. On redditads this is a connection authorized before Zernio needed a Reddit permission it now uses (for example adsconversions): Reddit refuses those requests until the user reconnects and allows every permission on Reddit's consent screen.

get/v1/accounts/{accountId}/health

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/accounts/{accountId}/health
  • Auth: HTTP bearer

Path parameters

accountIdstring required

The account ID to check

Response

Account health details

accountIdstring
platformstring
integrationLane'business' | 'developer'

TikTok only. The TikTok integration the account is connected through: business (TikTok for Business, Accounts API) or developer (the original integration). Absent on other platforms.

usernamestring
displayNamestring
status'healthy' | 'warning' | 'error'

Overall health status

issuesstring[]

List of issues found

recommendationsstring[]

Actionable recommendations to fix issues

Changes

    • info

      added the optional property to the response with the status

    • warning

      added the new account enum value to the / response property for the response status

    • warning

      added the new account enum value to the / response property for the response status