Track Accounts

Refresh tracked accounts data

Manually refresh data for specific tracked accounts. Only refreshes accounts with active account tracking. An account a manual refresh was already requested for in the last 10 minutes, by anyone in the organization, is not refreshed or charged again: it is listed under skipped. A request whose accounts are all skipped succeeds with an empty refreshed list. The X-Viral-Credits-Consumed response header carries the credits charged.

⚠️ Consumes extra credits: 3 credits per tracked video – rounded up per account.

post/accounts/tracked/refresh

Request

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

Request body

Example request

{
  "items": [
    {
      "platform": "facebook",
      "id": "100044278427060"
    },
    {
      "platform": "tiktok",
      "id": "102215305149431808"
    },
    {
      "platform": "instagram",
      "id": "10674663966"
    },
    {
      "platform": "youtube",
      "id": "UCXWVIsxzHo905JK7_PPONA"
    }
  ]
}

Response

OK

totalRefreshednumber required
eventIdsstring[] required
syncRequestIdstring nullable required

The sync this request started. The sync.completed webhook reports it under this id (sync.id) once it is over, every item live or failed. Null when nothing was synced, or when viral.app could not record the sync for progress tracking (the sync still runs; no sync.completed follows).

Example response

{
  "refreshed": [
    {
      "id": "orgacc_VA542FB0001",
      "platformAccountId": "100044278427060",
      "username": "mrtechnicaldifficult",
      "platform": "facebook"
    },
    {
      "id": "orgacc_W97M6KLWV4Yq",
      "platformAccountId": "102215305149431808",
      "username": "vioundvivi",
      "platform": "tiktok"
    },
    {
      "id": "orgacc_X98N7LMXW5Zr",
      "platformAccountId": "10674663966",
      "username": "domi.succeeds",
      "platform": "instagram"
    },
    {
      "id": "orgacc_Y99O8MNYX6As",
      "platformAccountId": "UCXWVIsxzHo905JK7_PPONA",
      "username": "fullthrottlef1yt",
      "platform": "youtube"
    }
  ],
  "totalRefreshed": 4,
  "eventIds": [
    "01HQX5N6R4Z8K7WJQT9S3YVMGH",
    "01HQX5N6R5A9M8XKRU0T4ZWNHJ",
    "01HQX5N6R6B0N9YMRV1U5AXOJK",
    "01HQX5N6R7C1P0ZNSW2V6BYPKL"
  ],
  "syncRequestId": "sr_V1StGXR8Z5jdHi6BmyT2q",
  "skipped": []
}

Changes

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