Update a tracker
PATCH
/v1/trackers/{id}Pauses or resumes the Tracker, switches its analysis on or off, or both. A paused Tracker runs no cycles and is charged nothing. Analysis applies from the next cycle and is charged per new video or Ad it analyses.
Price
Free.
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
id | path | string | Required | — | Tracker id. |
Request body
application/json
object
statestringone ofactive,pausedPause or resume. A paused Tracker runs no cycles.intelligencebooleanSwitch analysis of new videos or Ads on or off, from the next cycle. Pass this,state, or both.
Responses
200 OK
{ tracker }.
object
trackerobjectrequiredidstringrequiredkindstringrequiredone ofcreator,hashtag,sound,advertiser,videovideois deprecated (ADR 0024): existing Video Trackers keep working, new ones are refused with 400kind_deprecated.platformstringrequiredmetafor an advertiser Tracker.targetstringrequiredintelligencebooleanrequiredWhether each new video (or Ad) the cycle finds is analysed.statestringrequiredone ofactive,paused,deletedlast_cycle_atstringrequirednullablelast_run_idstringrequirednullablecreated_atstringrequiredupdated_atstringrequired
200 · `{ tracker }`.
{
"tracker": {
"id": "trk_4b1e90c7aa",
"kind": "creator",
"platform": "tiktok",
"target": "someone",
"intelligence": true,
"state": "paused",
"last_cycle_at": "2026-09-08T04:00:11.402Z",
"last_run_id": "run_c07a41bb92",
"created_at": "2026-09-01T11:20:03.118Z",
"updated_at": "2026-09-08T04:00:11.402Z"
}
}401 Unauthorized
missing_authorization, invalid_key, key_revoked or invalid_token.
object
RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose.
typestringrequiredtitlestringrequiredstatusintegerrequiredcodestringrequiredone ofmissing_authorization,invalid_key,key_revoked,invalid_token,organization_not_selected,organization_access_revoked,connection_revoked,forbidden,invalid_request,unsupported_platform,unsupported_kind,kind_deprecated,not_found,video_too_long,idempotency_conflict,run_not_ready,advertiser_ambiguous,insufficient_balance,rate_limit_exceeded,concurrency_limit_exceeded,tracker_limit_exceeded,webhook_limit_exceeded,webhook_rotation_in_progress,collection_limit_exceeded,collection_name_taken,collection_kind_mismatch,media_unavailable,vendor_error,source_unavailable,service_unavailable,internal_errorStable machine-readable code.detailstring
401 · Example
{
"type": "https://www.shortsintel.com/docs/reference/errors/invalid_key",
"title": "Invalid key",
"status": 401,
"code": "invalid_key",
"detail": "That API key does not exist. Keys look like `sk_live_...` and are created in the console."
}409 Conflict
tracker_limit_exceeded when resuming would exceed the cap.
object
RFC 9457 problem document, served as application/problem+json. Branch on code, never on the prose.
typestringrequiredtitlestringrequiredstatusintegerrequiredcodestringrequiredone ofmissing_authorization,invalid_key,key_revoked,invalid_token,organization_not_selected,organization_access_revoked,connection_revoked,forbidden,invalid_request,unsupported_platform,unsupported_kind,kind_deprecated,not_found,video_too_long,idempotency_conflict,run_not_ready,advertiser_ambiguous,insufficient_balance,rate_limit_exceeded,concurrency_limit_exceeded,tracker_limit_exceeded,webhook_limit_exceeded,webhook_rotation_in_progress,collection_limit_exceeded,collection_name_taken,collection_kind_mismatch,media_unavailable,vendor_error,source_unavailable,service_unavailable,internal_errorStable machine-readable code.detailstring
409 · Example
{
"type": "https://www.shortsintel.com/docs/reference/errors/tracker_limit_exceeded",
"title": "Tracker limit exceeded",
"status": 409,
"code": "tracker_limit_exceeded",
"detail": "Resuming this Tracker would take you past 100 active Trackers.",
"limit": 100,
"active": 100
}Request samples
curl -X PATCH "https://www.shortsintel.com/v1/trackers/trk_4b1e90c7aa" \
-H "Authorization: Bearer sk_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"state":"paused","intelligence":true}'const response = await fetch(
"https://www.shortsintel.com/v1/trackers/trk_4b1e90c7aa",
{
method: "PATCH",
headers: {
"Authorization": "Bearer sk_live_YOUR_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify({
"state": "paused",
"intelligence": true
}),
},
);
if (!response.ok) {
throw new Error(`ShortsIntel ${response.status}`);
}
const data = await response.json();import requests
response = requests.patch(
"https://www.shortsintel.com/v1/trackers/trk_4b1e90c7aa",
headers={
"Authorization": "Bearer sk_live_YOUR_KEY",
"Content-Type": "application/json",
},
json={
"state": "paused",
"intelligence": True,
},
)
response.raise_for_status()
data = response.json()Related guides
- Trackers: Standing watches on a creator or a Meta Advertiser: how a cycle runs, when it reports a change, and how to pause one.