Rank Tracking

Add one or more tracked keywords

Changed on

Track one keyword or a batch of keywords for rank monitoring. Tracking works at country level AND at local level (city, county, state, region, neighbourhood). For country level, set countryId to an ISO2 code. For anywhere more specific, call search_locations first and pass the result's criteriaId as locationCriteriaId and its canonicalName as locationCanonicalName - do not invent either value. On plans with a keyword-tracking allowance, each tracked keyword uses it (402 at the limit) and checks are free. On plans that bill checks in credits there is no keyword limit: the first check runs right away unless enqueue is false, then every scheduled check costs credits (see rank_tracking_settings for the price). active: false only saves the keywords and costs nothing.

post/v3/rank-tracking/keywords

Request

  • Base URL
    https://api.snowseo.com
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Request body

teamIdstring

Team ID

keywordstring

Keyword to track

countryIdstring nullable

Country ID (ISO2) or null for worldwide. Set this alongside a location when targeting a place inside a country.

languageIdstring nullable

Language ID or null for default

locationCriteriaIdnumber nullable

Google Ads location criteria ID for local (sub-country) tracking - city, county, state, region or neighbourhood. Get it from search_locations; never guess it. Omit/null for country-only tracking.

locationCanonicalNamestring nullable

Canonical location name from the same search_locations row (e.g. "Palm Beach County,Florida,United States"). Send it whenever locationCriteriaId is set; if omitted the stored canonical name is null.

activeboolean

Defaults to true. Set false to add the keywords to the team's list WITHOUT tracking them: no SERP allowance is consumed and no crawl is scheduled, and they can be tracked later. Batch (items) only.

enqueueboolean

Defaults to true: newly tracked keywords get their first Google check right away, which costs credits on plans that bill checks in credits. When false, skips only that first check. The keywords are still tracked, so the scheduled refresh checks them and bills for it on its next pass.

Response

Default Response

successboolean
requestednumber
alreadyTrackednumber
reactivatednumber
creatednumber

Changes

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    7 more changes in this revision