Change a watch (apps, competitors, terms, countries, event types, thresholds) or pause it with active=false.

PATCHhttps://api.appgoat.ai/v1/watches/{id}

FreeoperationId updateWatch

Send only what changes; settings is merged into the current settings. Growing a watch re-checks your plan's limits (402 plan_limit).

Request

curl -X PATCH "https://api.appgoat.ai/v1/watches/123" \
  -H "x-api-key: $APPGOAT_API_KEY" \
  -H "content-type: application/json" \
  -d '{"competitors":["389801252","com.instagram.android"],"settings":{"significance":0.7}}'

const res = await fetch("https://api.appgoat.ai/v1/watches/123", {
  method: 'PATCH',
  headers: {
    "x-api-key": process.env.APPGOAT_API_KEY,
    "content-type": "application/json",
  },
  body: JSON.stringify({"competitors":["389801252","com.instagram.android"],"settings":{"significance":0.7}}),
});
const { data, meta } = await res.json();

import os, requests

res = requests.patch(
    "https://api.appgoat.ai/v1/watches/123",
    headers={"x-api-key": os.environ["APPGOAT_API_KEY"]},
    json={"competitors":["389801252","com.instagram.android"],"settings":{"significance":0.7}}
)
body = res.json()

Path parameters

idintegerrequired

Request body

JSON, required.

namestring | null

appstring | null

competitorsstring[]

termsstring[]

store"apple" | "play" | "both"

countriesstring[]

event_typesEventType[] | null

settingsWatchSettings

activeboolean

Response

200 with data: Watch. See the envelope for meta.

idinteger

kindWatchKind

namestring | null

store"apple" | "play" | "both" | null

appany

competitorsWatchApp[]

competitor_set only.

termsstring[]

keyword only.

keywordsobject[]

keyword only: one slot per store × country × term (id = the tracked-keyword id).

keywords[].idinteger

keywords[].termstring

keywords[].storeStore

keywords[].countrystring

keywords[].ranked_atstring | null

countriesstring[]

event_typesEventType[]

settingsWatchSettings

activeboolean

created_atstring

updated_atstring

Example

{
  "data": {
    "id": 1,
    "kind": "app",
    "name": "string",
    "store": "apple",
    "app": null,
    "competitors": [
      {
        "store": "apple",
        "app_id": "324684580",
        "title": "Spotify: Music and Podcasts",
        "icon_url": "string",
        "developer_name": "string"
      }
    ],
    "terms": [
      "string"
    ],
    "keywords": [
      {
        "id": 1,
        "term": "photo editor",
        "store": "apple",
        "country": "us",
        "ranked_at": "2026-10-22T10:00:00Z"
      }
    ],
    "countries": [
      "string"
    ],
    "event_types": [
      "new_version"
    ],
    "settings": {
      "significance": 0.5,
      "rank_move": 5,
      "keyword_top_n": 10,
      "chart_top_n": 100,
      "rating_drop": 0.1,
      "spike_factor": 3,
      "email_digest": true,
      "depth": 1,
      "cadence_minutes": 1
    },
    "active": false,
    "created_at": "2026-10-22T10:00:00Z",
    "updated_at": "2026-10-22T10:00:00Z"
  },
  "meta": {
    "credits_used": 0,
    "credits_remaining": 9981,
    "request_id": "req_123"
  }
}

Status codes

200

The updated watch.

400invalid_param

A parameter is missing or invalid (error.param names it).

401invalid_api_key

Missing or invalid API key.

402insufficient_creditsplan_limit

insufficient_credits (the call costs more than you have left; nothing was done) or plan_limit (a feature of a higher plan).

404not_found

Not found.

429rate_limited

Too many requests per second for your plan.