Track Accounts

List all tracked accounts

Retrieves paginated organization tracked accounts with user details, analytics data, and project associations.

get/accounts/tracked

Request

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

Query parameters

pagenumber

Page number (1-based index)

Example:1
perPagenumber

Number of items per page (1-100)

Example:10
sortColstring

Sort column

Example:publishedAt
sortDir'asc' | 'desc'

Sort direction

Example:asc
searchstring

Account username on the platform

Example:acme
accountsstring[] nullable

Organization account IDs

[
  "orgacc_1A2B3C4D5E6F"
]
platformsstring[] nullable

Social media platforms (facebook, instagram, tiktok, youtube, snapchat)

[
  "facebook",
  "instagram"
]
projectsstring[] nullable

Organization project IDs

Deprecated. Use tag filters (tags / tagGroups) instead — a project's virtual project tag id (orgproj_…) works as a tag id. See the migration guide.

[
  "orgproj_1A2B3C4D5E6F"
]
tagsstring[] nullable

Tag IDs. Custom and project tags must all match (intersection); country tags and continent:<CODE> values combine into one geographic group satisfied by any of them. none:<category> values (custom/project/country/continent) match entities WITHOUT any tag of the category. Ignored when tagGroups is provided.

[
  "orgtag_1A2B3C4D5E6F"
]
mode'any' | 'all' required

How the group's tags combine: any = OR, all = intersection.

idsstring[] required

Tag IDs, including continent:<CODE> and none:<category> values.

[
  {
    "mode": "all",
    "ids": [
      "orgtag_1A2B3C4D5E6F"
    ]
  },
  {
    "mode": "any",
    "ids": [
      "systag_1A2B3C4D5E6F",
      "continent:EU"
    ]
  }
]
tagsMatch'rules' | 'videos'

How the tag filter targets rows: rules (default) matches entity-level tag rules only; videos matches rows with at least one video satisfying the whole filter.

Example:rules
viewMode'internal' | 'competitors' | 'all'

Response

OK

pageCountnumber required

Total number of pages

totalRowsnumber required

Total number of rows

Example response

{
  "data": [
    {
      "id": "orgacc_W97M6KLWV4Yq",
      "platform": "tiktok",
      "platformAccountId": "68968912345678900",
      "maxVideos": 100,
      "orgCreatorId": null,
      "lastErrorAt": null,
      "lastErrorCode": null,
      "createdAt": "2025-01-15T10:00:00.000Z",
      "updatedAt": "2025-12-20T08:00:00.000Z",
      "actorType": "user",
      "userId": "user_PxyfnFj5JUx5",
      "orgId": "org_GbuDqv3RjdSW",
      "username": "viral_creator",
      "displayName": "Viral Creator",
      "individualVideos": 15,
      "analyticsLatestLoadAt": "2025-12-20T08:00:00Z",
      "hasAnalytics": true,
      "latestVideoPublishedAt": "2025-12-19T16:30:00Z",
      "user": {
        "id": "user_PxyfnFj5JUx5",
        "name": "John Doe",
        "image": "https://example.com/avatar.jpg",
        "firstName": "John",
        "lastName": "Doe",
        "role": "member"
      },
      "projects": [
        {
          "id": "orgproj_RwmraAffhMt9",
          "name": "Holiday Campaign 2024",
          "logo": "https://example.com/project-logo.png"
        }
      ]
    },
    {
      "id": "orgacc_pbWejFdiFqQK",
      "platform": "facebook",
      "platformAccountId": "100044278427060",
      "maxVideos": 30,
      "orgCreatorId": null,
      "lastErrorAt": "2025-12-18T14:30:00.000Z",
      "lastErrorCode": "PRIVATE_CONTENT",
      "createdAt": "2025-02-01T14:30:00.000Z",
      "updatedAt": "2025-12-18T14:30:00.000Z",
      "actorType": "user",
      "userId": "user_9uzTzeSobgkd",
      "orgId": "org_QgqAir1Eydfc",
      "username": "mrtechnicaldifficult",
      "displayName": "Mr Technical Difficult",
      "individualVideos": 8,
      "analyticsLatestLoadAt": "2025-12-17T10:15:00Z",
      "hasAnalytics": true,
      "latestVideoPublishedAt": null,
      "user": {
        "id": "user_9uzTzeSobgkd",
        "name": "Jane Smith",
        "image": null,
        "firstName": "Jane",
        "lastName": "Smith",
        "role": "admin"
      },
      "projects": []
    }
  ],
  "pageCount": 5,
  "totalRows": 23
}

Changes

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