Skip to main content
These recipes chain real v2 endpoints into the kind of task an agent runs end to end. Each is idempotency-minded, paginated where it needs to be, and error-aware. Every request needs Authorization: Bearer YOUR_API_KEY; the header is omitted below for brevity.
Response fields vary by endpoint — fetch and read the live shape rather than assuming it. The interactive explorer shows each response in full.

​
Onboard and report

Start tracking an account, then summarize its recent engagement.
1

Track the account

POST /v2/accounts with the platform and handle. Send an Idempotency-Key so a retry doesn’t create a duplicate.
Read the id from the created account in the response.
2

Pull the last 7 days of analytics

GET /v2/accounts/{id}/analytics with a date window. Metrics build up over the following scrape cycles, so a brand-new account may have little history yet.
3

Summarize

Feed the returned daily series to the model and ask for a short engagement summary. Quote the X-Request-ID from the analytics call in your run log for traceability.

​
Daily standup digest

Compose a morning digest from the headline view plus the leaderboard.
1

Fetch the overview

GET /v2/overview returns organization-level figures. Pass a period (for example 7d) if you want a windowed view.
2

Fetch top creators

GET /v2/creators/top ranks your creators over a period.
3

Format the digest

Hand both JSON payloads to the model and ask for a short standup message — headline numbers from the overview, then the top creators. Post it to Slack, email, or wherever the team reads it.

​
Find and track

Discover an account or video by query, then start tracking it.
1

Search

GET /v2/search?q=... searches accounts, creators, and videos.
Let the model pick the best match from the results and read its identifier.
2

Track the video

POST /v2/videos accepts a full post URL (or platform identifier). Use an Idempotency-Key keyed to the URL.
To track a whole account instead of a single post, POST /v2/accounts (see the first recipe). CreatorAudit then discovers that account’s videos for you under /v2/account-videos.

​
Backfill metrics across a video library

Page through every tracked video, then pull windowed metrics for the batch.
1

Paginate the video list

GET /v2/videos returns a page of videos plus a pagination object. Loop on the cursor until has_next is false, collecting each video id.
2

Request metrics in batches

POST /v2/videos/metrics takes up to 200 video IDs and a window. Send the IDs you collected in batches of 200 with a period (7d, 30d, 90d, or custom with start_date/end_date).
3

Aggregate

Merge the metric batches and let the model summarize trends. The same pattern works for accounts via POST /v2/accounts/metrics (with account_ids).

​
Loop discipline for every recipe

Build these as resilient loops, not one-shot scripts — an agent will retry, and the API may return partial pages.
  • Idempotency. Set an Idempotency-Key header on POST /v2/accounts, POST /v2/videos, and POST /v2/creators, keyed to the logical action, so retries don’t duplicate.
  • Pagination. Always read pagination.has_next and pass pagination.next_cursor as cursor. Never assume one page is the whole set.
  • Error awareness. On 4xx/5xx, parse the RFC 9457 body — branch on status and the machine-readable code — and back off rather than hammering. Capture X-Request-ID from every response.
  • Batch limits. Metrics endpoints accept 1–200 IDs per call; chunk larger sets.
See Use the API as agent tools for the executor that wraps these calls, and the API reference for the shared conventions.