Analytics · Watchlist
Returns daily watchlist rules. Works with Instagram and YouTube accounts.
GET
https://api.pozy.ai/v1/watchlist/rulesInstagram and YouTubelistWatchlistRules
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the analytics resource group disabled get 403 resource_group_disabled. Authentication
Example
curl -X GET "https://api.pozy.ai/v1/watchlist/rules" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/watchlist/rules", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/watchlist/rules",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
rulesarray of object11 child fields
idstringrequirednamestringrequiredfilterobjectrequired8 child fields
listIdstringCan be null.
platformstringOne of
instagram,youtube. Can be null.formatsarray of stringEach item: one of
reel,carousel,image,video,short.minViewsintegerCan be null.
minLikesintegerCan be null.
minCommentsintegerCan be null.
outlierMinnumberAt least 1. Can be null.
maxAgeDaysinteger1 to 30. Can be null.
targetAccountIdsarray of stringrequiredactionstringOne of
draft.hourUtcintegerrequired0 to 23.
maxPerRunintegerrequired1 to 10.
enabledbooleanrequiredlastRunAtstring (date-time)Can be null.
lastResultobjectCan be null.
createdAtstring (date-time)
limitinteger
200 response
{
"rules": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"name": "Acme",
"filter": {
"listId": "64272240067877d9e057f3da",
"platform": "instagram",
"formats": [
"reel"
],
"minViews": 1,
"minLikes": 1,
"minComments": 1,
"outlierMin": 12.5,
"maxAgeDays": 1
},
"targetAccountIds": [
"string"
],
"action": "draft",
"hourUtc": 1,
"maxPerRun": 1,
"enabled": true,
"lastRunAt": "2026-10-02T09:00:00.000Z",
"lastResult": {},
"createdAt": "2026-10-02T09:00:00.000Z"
}
],
"limit": 1
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.
More in Watchlist
GETList watchlist listsPOSTCreate a watchlist listPATCHRename a watchlist listDELDelete a watchlist list (its accounts stay watched)GETList watched accountsPOSTWatch a public accountGETGet a watched account with its statsPATCHMove a watched account to another listDELStop watching an accountPOSTUpdate a watched account now (once an hour)GETList and rank posts from watched accountsGETGet a watched post with its Make my version briefPUTSave a post to the swipe fileDELRemove a post from the swipe filePOSTRecord that you made your version of a postDELClear the version record of a postPOSTCreate a daily rule that saves adapted draftsPATCHUpdate a daily watchlist ruleDELDelete a daily watchlist rulePOSTRun a watchlist rule now (or preview it)