Skip to main content

AccountConnectionHealth

Connection health of an account (todo 27). Never contains token values.

statusstringrequired

expired: must be reconnected now. expiring: the connection hits its hard expiry within 7 days. failing: the latest publish attempt failed. healthy: none of these.

Possible values: [healthy, failing, expiring, expired]

expiry_kindstringrequired

What limits the connection: access (the access token), refresh (the refresh token), expired, unknown (refreshed automatically, no known hard limit) or none (the network's connections do not expire on a schedule).

Possible values: [access, refresh, expired, unknown, none]

expires_at(string | null)<date-time>nullablerequired

When the connection stops working unless reconnected; null without a hard expiry.

days_leftinteger | nullnullablerequired

Whole days until expires_at (0 = less than a day).

refreshablebooleanrequired

PostBoost refreshes the token automatically until the hard expiry.

notestringrequired

Plain-language explanation of the prediction.

reconnect_reason object | nullrequired

Why the daily token check found the account's token dead, for an account that needs a reconnect; null otherwise. Codes: meta_190_<subcode> (Facebook, Instagram), refresh_expired (TikTok, Pinterest), linkedin_revoked, linkedin_expired, google_revoked (YouTube).

codestringrequired
Example: linkedin_revoked
messagestringrequired

The reason in plain language.

found_atstring<date-time>required

When the check first found the token dead.

last_success_at(string | null)<date-time>nullablerequired

When the account last published successfully.

last_errorstring | nullnullablerequired

The error of the account's latest failed publish, shortened to 300 characters.

reconnect_urlstring<uri>required

Where a workspace member reconnects the account.

AccountConnectionHealth
{
"status": "healthy",
"expiry_kind": "access",
"expires_at": "2024-07-29T15:51:28.071Z",
"days_left": 0,
"refreshable": true,
"note": "string",
"reconnect_reason": "Unknown Type: object,null",
"last_success_at": "2024-07-29T15:51:28.071Z",
"last_error": "string",
"reconnect_url": "string"
}