keywords

Set keyword target URL or metadata

patch/keywords/{keyword_id}

Request

  • Base URL: https://eu.bisibility.com/api/v1
  • URL: https://eu.bisibility.com/api/v1/keywords/{keyword_id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /api/auth/oauth2/authorize, token URL /api/auth/oauth2/token, scopes: api:write)

Path parameters

keyword_idstring required

Public keyword ID.

Example:kw_a00000000000000000000000

Query parameters

projectstring

Query-parameter equivalent of the X-Bisibility-Project header for personal-access-token project selection. Optional. Selection precedence is: {project_id} path parameter, X-Bisibility-Project header, project query parameter, then inference when the PAT owner belongs to exactly one project.

Headers

Bisibility-API-Version'v1'

API contract version requested by the client. Omit this header to use the current backward-compatible behavior.

X-Bisibility-Projectstring

Project public ID (prj_...) targeted by this personal-access-token request. Optional. Selection precedence is: {project_id} path parameter, X-Bisibility-Project header, project query parameter, then inference when the PAT owner belongs to exactly one project. Project API keys and paths that already carry a project ID ignore it.

X-Bisibility-Source'sdk' | 'cli' | 'mcp'

Declares the client that produced the request for usage reporting: sdk, cli or mcp. Optional; any other value counts as api. It never changes authentication or which budget applies (every bearer-authenticated request counts against the API, MCP and SDK budget).

Response

JSON response

countrystring required

Resolved keyword location display name.

created_atstring date-time required
device'desktop' | 'mobile' required
idstring required
intentstring nullable required
latest_positioninteger nullable required

latest_position = latest_check.position; it is null for failed checks, unknown observation coverage, or absence within the requested depth. Agents that need "the last known ranking" must read latest_successful_check.position.

language_codestring required
language_labelstring required
locationstring required

Resolved keyword location display name.

location_keystring required

Canonical country, region, or city key, optionally qualified with @language. The default language normalizes to the unqualified key.

previous_positioninteger nullable required

previous_position = the position recorded on latest_check as its predecessor.

project_idstring required
ranking_urlstring nullable required
tagsstring[] required
target_urlstring nullable required
textstring required
topicstring nullable required
updated_atstring date-time required

Example response

{
  "country": "Austin, Texas, United States",
  "id": "kw_a00000000000000000000000",
  "latest_check": {
    "id": "check_a00000000000000000000000",
    "run_id": "rcr_a00000000000000000000000"
  },
  "latest_successful_check": {
    "id": "check_a00000000000000000000000",
    "run_id": "rcr_a00000000000000000000000"
  },
  "language_code": "en",
  "language_label": "English",
  "location": "Austin, Texas, United States",
  "location_key": "ES/Andalusia/Malaga@en",
  "project_id": "prj_a00000000000000000000000",
  "text": "rank tracker api"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.