Track Individual Videos

Refresh individually tracked videos data

Manually refresh data for specific individually tracked videos. Only works for individual videos, not videos from tracked accounts. A video 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 videos 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 video.

post/videos/tracked/refresh

Request

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

Request body

Example request

{
  "items": [
    {
      "platform": "facebook",
      "id": "1487463749406225"
    },
    {
      "platform": "tiktok",
      "id": "6768504823336815877"
    },
    {
      "platform": "instagram",
      "id": "C_WdbENfYw"
    },
    {
      "platform": "youtube",
      "id": "iZvCjtYck"
    }
  ]
}

Response

OK

totalRefreshednumber 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": "orgvid_90qAFTH8K5Ca",
      "platformVideoId": "1487463749406225",
      "platform": "facebook"
    },
    {
      "id": "orgvid_91rBGUI9L6Db",
      "platformVideoId": "6768504823336815877",
      "platform": "tiktok"
    },
    {
      "id": "orgvid_92sCHVJ0M7Ec",
      "platformVideoId": "C_WdbENfYw",
      "platform": "instagram"
    },
    {
      "id": "orgvid_93tDIWK1N8Fd",
      "platformVideoId": "iZvCjtYck",
      "platform": "youtube"
    }
  ],
  "totalRefreshed": 4,
  "syncRequestId": "sr_V1StGXR8Z5jdHi6BmyT2q",
  "skipped": []
}

Changes

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