Skip to main content
POST
Track an account

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
username
string
required

Account handle to track.

Required string length: 1 - 128
creator_id
string<uuid> | null

Optional creator to link this account to.

category
string | null

Optional category label.

Maximum string length: 128
metadata
Metadata · object | null

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

scrape_interval_hours
integer
default:24

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

Required range: 6 <= x <= 720

Response

Successful Response

data
AccountResponse · object
required

A tracked Instagram or TikTok account with its latest engagement metrics and per-account tracking configuration.