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

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
platform
enum<string>

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>

Current account health.

Available options:
healthy,
warning,
error

Response

The result

results
object[]
required

Health of your own accounts.

summary
object
required

Totals recomputed from returned accounts.