Skip to content

Latest commit

 

History

History
237 lines (135 loc) · 8.73 KB

File metadata and controls

237 lines (135 loc) · 8.73 KB

\AccountsApi

All URIs are relative to https://zernio.com/api

Method HTTP request Description
delete_account DELETE /v1/accounts/{accountId} Disconnect account
get_account_health GET /v1/accounts/{accountId}/health Check account health
get_all_accounts_health GET /v1/accounts/health Check accounts health
get_follower_stats GET /v1/accounts/follower-stats Get follower stats
get_tik_tok_creator_info GET /v1/accounts/{accountId}/tiktok/creator-info Get TikTok creator info
list_accounts GET /v1/accounts List accounts
update_account PUT /v1/accounts/{accountId} Update account

delete_account

models::DeleteAccountGroup200Response delete_account(account_id) Disconnect account

Disconnects and removes a connected social account.

Parameters

Name Type Description Required Notes
account_id String [required]

Return type

models::DeleteAccountGroup200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_account_health

models::GetAccountHealth200Response get_account_health(account_id) Check account health

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

Parameters

Name Type Description Required Notes
account_id String The account ID to check [required]

Return type

models::GetAccountHealth200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_all_accounts_health

models::GetAllAccountsHealth200Response get_all_accounts_health(profile_id, platform, status) Check accounts health

Returns health status of all connected accounts including token validity, permissions, and issues needing attention.

Parameters

Name Type Description Required Notes
profile_id Option<String> Filter by profile ID
platform Option<String> Filter by platform
status Option<String> Filter by health status

Return type

models::GetAllAccountsHealth200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_follower_stats

models::GetFollowerStats200Response get_follower_stats(account_ids, profile_id, from_date, to_date, granularity) Get follower stats

Returns follower count history and growth metrics for connected social accounts. Requires analytics add-on subscription. Follower counts are refreshed once per day.

Parameters

Name Type Description Required Notes
account_ids Option<String> Comma-separated list of account IDs (optional, defaults to all user's accounts)
profile_id Option<String> Filter by profile ID
from_date Option<String> Start date in YYYY-MM-DD format (defaults to 30 days ago)
to_date Option<String> End date in YYYY-MM-DD format (defaults to today)
granularity Option<String> Data aggregation level [default to daily]

Return type

models::GetFollowerStats200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_tik_tok_creator_info

models::GetTikTokCreatorInfo200Response get_tik_tok_creator_info(account_id, media_type) Get TikTok creator info

Returns TikTok creator details, available privacy levels, posting limits, and commercial content options for a specific TikTok account. Only works with TikTok accounts.

Parameters

Name Type Description Required Notes
account_id String The TikTok account ID [required]
media_type Option<String> The media type to get creator info for (affects available interaction settings) [default to video]

Return type

models::GetTikTokCreatorInfo200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_accounts

models::ListAccounts200Response list_accounts(profile_id, platform, include_over_limit, page, limit) List accounts

Returns connected social accounts. Only includes accounts within the plan limit by default. Follower data requires analytics add-on. Supports optional server-side pagination via page/limit params. When omitted, returns all accounts (backward-compatible).

Parameters

Name Type Description Required Notes
profile_id Option<String> Filter accounts by profile ID
platform Option<String> Filter accounts by platform (e.g. "instagram", "twitter").
include_over_limit Option<bool> When true, includes accounts from over-limit profiles. [default to false]
page Option<i32> Page number (1-based). When provided with limit, enables server-side pagination. Omit for all accounts.
limit Option<i32> Page size. Required alongside page for pagination.

Return type

models::ListAccounts200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_account

models::UpdateAccount200Response update_account(account_id, update_account_request) Update account

Updates a connected social account's display name or username override. For X/Twitter accounts on usage-based billing, also accepts an xCapabilities object to toggle background API operations that incur X API pass-through costs. Both fields are opt-in (default false) — when off, no analytics syncs or DM polling are performed for that account, and no API call is metered for those operations. Publishing and deleting posts are always available regardless of these toggles. Setting xCapabilities on a non-X account returns 400.

Parameters

Name Type Description Required Notes
account_id String [required]
update_account_request UpdateAccountRequest [required]

Return type

models::UpdateAccount200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]