Skip to main content
POST
/
videos
Track a video
curl --request POST \
  --url https://api.creatoraudit.com/v2/videos \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "<string>",
  "metadata": {},
  "is_active": true,
  "scrape_interval_hours": 24
}
'
{
  "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": {}
  }
}

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string | null

Optional client-supplied unique key for retry-safe POSTs. Best-effort in-process dedup over a 10-minute window. Multi-replica deployments will need a shared store before this is load-bearing across all writes.

Body

application/json
platform
enum<string>
required

Platform to track: instagram or tiktok.

Available options:
instagram,
tiktok
identifier
string
required

The post/video to track. Accepts a full URL (instagram.com/p/{shortcode}, tiktok.com/@user/video/{id}), a numeric id, or — for Instagram only — a bare shortcode. The server resolves and normalizes it.

Required string length: 1 - 512
metadata
Metadata · object

Optional key/value tags (≤20 keys, ≤255 chars each).

is_active
boolean
default:true

Track as active (default true).

scrape_interval_hours
integer
default:24

Refresh cadence in hours (6–720). Defaults to 24.

Required range: 6 <= x <= 720

Response

Successful Response

data
VideoResponse · object
required

A tracked post/video with its content fields and latest metrics.