Filtering
Common filter parameters across list endpoints:Restrict to one platform —
instagram or tiktok.Case-insensitive substring search (for example, over an account’s username).
Filter by tracking state — active versus paused.
Scope results to a single account (UUID). Available where it makes sense, such as
listing videos.
Scope accounts to a single creator (UUID).
AND. The response echoes the active filter and sort back in
the filters envelope so you can confirm what produced the page.
Filter parameters are per-endpoint. For example,
/v2/accounts also accepts
category and creator_id, while /v2/videos accepts account_id. Check the
endpoint page for the full list.Date ranges
The analytics endpoints accept date-range parameters instead of the filters above. Daily endpoints take an inclusivestart_date and end_date (YYYY-MM-DD), and
the timeseries endpoints add a period preset (7d, 30d, 90d, or custom
with explicit dates). See the analytics endpoints in the
API reference for specifics.
Sorting
Sort with two parameters:Field to sort by. Allowed values are a per-endpoint enum (see below).
Sort direction —
asc or desc.| Endpoint | order_by values |
|---|---|
/v2/accounts | added_at, username, last_scrape_time, follower_count, view_count, like_count, play_count |
/v2/videos | added_at, create_time, view_count, like_count, play_count |
A legacy
sort parameter accepts a single signed string such as -added_at (leading
- for descending). Prefer order_by + order_direction, which are validated as
enums; if both are present, order_by wins.Combining with pagination
Filters and sort are part of the cursor’s identity. Hold them constant across every page of a walk — a cursor reused under a different filter or sort returns422.
See Pagination.