Skip to main content
GET
/
videos
List tracked videos
curl --request GET \
  --url https://api.creatoraudit.com/v2/videos \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "type": "video",
      "shortcode": "<string>",
      "is_active": true,
      "scrape_interval_hours": 24,
      "metadata": {},
      "added_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "first_scrape_time": "2023-11-07T05:31:56Z",
      "last_scrape_time": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "create_time": "2023-11-07T05:31:56Z",
      "media_type": "<string>",
      "duration": 123,
      "is_unavailable": true,
      "cover_image_url": "<string>",
      "cover_image_url_original": "<string>",
      "video_url": "<string>",
      "video_url_original": "<string>",
      "view_count": 123,
      "like_count": 123,
      "comment_count": 123,
      "share_count": 123,
      "play_count": 123,
      "saved_count": 123,
      "total_views": 123,
      "total_plays": 123,
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_username": "<string>",
      "platform_account_id": "<string>",
      "platform_data": {}
    }
  ],
  "pagination": {
    "has_next": true,
    "limit": 123,
    "next_cursor": "<string>",
    "total_count": 123
  },
  "filters": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:50

Page size (1–200).

Required range: 1 <= x <= 200
cursor
string | null

Opaque pagination.next_cursor from the previous page.

sort
string
default:-added_at

Legacy signed sort string (e.g. -added_at). Prefer order_by + order_direction. Allowed keys: added_at, create_time, view_count, like_count, play_count.

order_by
enum<string> | null

Field to sort by. Overrides sort.

Available options:
added_at,
create_time,
view_count,
like_count,
play_count
order_direction
enum<string> | null

Sort direction (default desc). Used with order_by.

Available options:
asc,
desc
platform
enum<string> | null

Filter by platform: instagram or tiktok.

Available options:
instagram,
tiktok
is_active
boolean | null

Filter by tracking state (active vs paused).

account_id
string<uuid> | null

Only videos whose author is this tracked account.

q
string | null

Case-insensitive substring match against the video description.

Maximum string length: 128
include_total
boolean
default:false

When true, the response includes pagination.total_count. Adds one extra COUNT(*) query — leave off for cheap paging.

Response

Successful Response

data
VideoResponse · object[]
required
pagination
object
required
filters
Filters · object