Base URL
All v2 endpoints live under a single base URL:v2 is the current, stable version. v1 is legacy and deprecated — build new
integrations on v2. See Versioning for the policy.
Every request needs your organization API key as a bearer token, except the
unauthenticated
GET /health and GET /meta. See
Authentication.A first request
Verify your key and see which organization it belongs to withGET /v2/whoami:
Response envelope
Successful responses are wrapped in a consistent envelope.- Single resource —
{ "data": { ... } } - Collection —
{ "data": [ ... ], "pagination": { ... }, "filters": { ... } } - Collection with metadata —
{ "data": ..., "meta": { ... } }
pagination carries next_cursor, has_next, limit, and — when you pass
include_total=true — total_count. filters echoes the filter and sort that
produced the page. See Pagination and
Filtering and sorting.
Conventions
| Concern | Convention |
|---|---|
| Content type | Requests and responses are JSON; the API only produces JSON. |
| IDs | Resource IDs are UUIDs. |
| Timestamps | ISO 8601 in UTC (e.g. 2026-06-14T09:30:00Z); dates are YYYY-MM-DD. |
| Platforms | instagram or tiktok. |
| Request IDs | Every response echoes an X-Request-ID header for correlation. |
| Errors | RFC 9457 problem details (application/problem+json). |
application/json returns 415; a request
whose Accept header cannot be satisfied as JSON returns 406. Full details are
in Errors.
What the API covers
The endpoints are organized into seven resource groups. Browse them — each with a live request explorer — under Endpoints in the sidebar.Accounts
Track and manage Instagram and TikTok accounts. Creating an account begins automated
tracking.
Videos
Individually tracked posts, account-discovered videos, and batch engagement deltas.
Creators
Group accounts under a creator for roll-up analytics, plus the top-creators
leaderboard.
Analytics
Daily metrics and time series for the organization, accounts, creators, and videos,
plus batch windowed metrics.
Overview
Organization-wide headline stats with period-over-period changes.
Search
Cross-entity search over accounts, creators, and videos.
System
The unauthenticated
GET /health and GET /meta discovery document, plus GET /whoami.Playground and OpenAPI spec
Every endpoint page in this reference has an interactive playground: fill in your API key and parameters, send the request, and read the live response without leaving the docs. You can also work from the machine-readable spec:- Browse it at
openapi.json. - Fetch it programmatically —
GET /v2/metaadvertises the currentopenapi_url,docs_url, and API version.