Skip to main content
POST
social.account.health.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
accountId
string
required

Your connected account handle from social.accounts.list.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9_-]+$

Response

The result

accountId
string
required

Your connected account handle.

Required string length: 1 - 256
platform
enum<string>
required

Connected platform.

Available options:
facebook,
instagram,
linkedin,
x,
tiktok,
youtube,
threads,
pinterest,
reddit,
bluesky,
googlebusiness,
telegram,
snapchat,
discord,
slack,
whatsapp,
shopify,
wordpress,
linkedin-ads,
meta-ads,
pinterest-ads,
tiktok-ads,
x-ads,
google-ads,
openaiads,
whop-ads
status
enum<string>
required

Current account health.

Available options:
healthy,
warning,
error
token
object
required

Token validity; no token is returned.

permissions
object
required

Granted and missing native scopes.

handle
string

Your account handle.

Required string length: 1 - 256
displayName
string

Your account display name.

Required string length: 1 - 256
issues
enum<string>[]

Neutral issue codes.

Maximum array length: 6
Available options:
reconnect_required,
missing_permissions,
inactive,
messaging_paused,
connection_unavailable,
attention_required
recommendations
string[]

Fixed suggested actions.

Maximum array length: 6
Maximum string length: 256
analyticsSync
object

Analytics synchronization health.

messagingRestriction
object

Observed messaging restriction; it may lag the platform by one message.

connection
object

Live messaging connection check.

connectionType
enum<string>

Connected integration type.

Available options:
business,
developer