Skip to main content
DocsAPI ReferenceAI Agents & Resources
Tracking

Recurring trackers

Create, run, update, pause, and delete scheduled visibility trackers.

View Markdown

A tracker repeats visibility checks for a saved brand. It uses the brand's prompts and engines unless you provide tracker-specific overrides. The minimum interval is 60 minutes.

Create a tracker

curl -X POST https://api.trackee.dev/v1/trackers \
  -H "x-access-key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "brandId": "BRAND_ID",
    "name": "Daily startup PM check",
    "intervalMinutes": 1440,
    "captureSentiment": true
  }'

Creating and managing the tracker is free. Each run costs 3 credits per prompt per engine, plus 1 per combination when captureSentiment is true.

For example, five prompts across four engines cost 60 credits per run, or 80 with sentiment.

List or inspect trackers

curl https://api.trackee.dev/v1/trackers \
  -H "x-access-key: YOUR_ACCESS_KEY"

Each tracker reports its next and previous run times, latest status and error, and total run count. Fetch one tracker with GET /v1/trackers/{id}.

Run now

curl -X POST https://api.trackee.dev/v1/trackers/TRACKER_ID/run \
  -H "x-access-key: YOUR_ACCESS_KEY"

This adds a run without changing the recurring schedule. If the response returns queued: false, the job queue is unavailable and no scan was scheduled.

Update or pause

Change the name, interval, prompt and engine overrides, models, sentiment setting, or enabled state with PATCH:

curl -X PATCH https://api.trackee.dev/v1/trackers/TRACKER_ID \
  -H "x-access-key: YOUR_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "enabled": false }'

Pausing keeps the tracker configuration and existing history. Set enabled to true to resume it.

Delete

curl -X DELETE https://api.trackee.dev/v1/trackers/TRACKER_ID \
  -H "x-access-key: YOUR_ACCESS_KEY"

Deleting removes the recurring schedule. See the Trackers API reference for every request and response field.

On this page