Analytics · Watchlist

Run a watchlist rule now (or preview it)

Runs a watchlist rule now (or preview it). Works with Instagram and YouTube accounts.

POSThttps://api.pozy.ai/v1/watchlist/rules/{ruleId}/run
Instagram and YouTuberunWatchlistRule

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the analytics resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
ruleIdrequiredstring

Request body

application/json, required

  • dryRunboolean

    List the posts it would draft, without drafting.

Example

curl -X POST "https://api.pozy.ai/v1/watchlist/rules/6cd4059483de62b474d02fe7/run" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dryRun": true
}'

Response

200 on success

200 response
{}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Watchlist