Track Accounts

Preview a bulk max videos change (dry-run)

Runs the bulk max videos update's checks without writing: the accounts the ids or scope select, the per-platform clamp, the plan-meter units the change would add, and every refusal (plan feature, account or video limit) it would hit.

post/accounts/tracked/max-videos/preview

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/accounts/tracked/max-videos/preview
  • Auth: API key in header x-api-key

Request body

accountIdsstring[]

The tracked accounts to change (at least one), unless scope is given.

scope'internal' | 'competitors' | 'all'

Targets every tracked account of the organization instead of a list of ids: internal = the organization's own accounts, competitors = competitor accounts, all = both. Paused accounts (limit 0) are left out unless includePaused is true.

includePausedboolean

With scope: also target paused accounts (limit 0), which a limit resumes. Leave it out unless the user asks to resume paused accounts too.

Example request

{
  "accountIds": [
    "orgacc_W97M6KLWV4Yq",
    "orgacc_X98N7LMXW5Zr",
    "orgacc_Y99O8MNYX6As"
  ],
  "newMaxVideos": 100
}

Response

OK

okboolean required

True when the write would go through as previewed.

newMaxVideosnumber required
matchedAccountsnumber required

Accounts the ids or the scope select.

notFoundAccountIdsstring[]

Requested ids that are not tracked accounts of this organization.

changingAccountsnumber required

Accounts whose limit would change.

resumingAccountsnumber required

Paused accounts (limit 0) that would start tracking again.

pausingAccountsnumber required

Accounts that would be paused.

trackedVideosAddednumber required

Units the write adds to the tracked-videos plan meter (0 with the Unlimited Video Tracking feature, whose account videos do not count). Meter units, not credits.

trackedAccountsAddednumber required

Units the write adds to the tracked-accounts plan meter.

Example response

{
  "clampedAccounts": [
    {
      "platform": "facebook"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.