Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

Project-scoped API key. It cannot access account routes or create additional projects.

Headers

Bisibility-API-Version
enum<string>

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

Available options:
v1
X-Bisibility-Project
string

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.

Query Parameters

project
string

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.

Response

JSON response

country
string
required

Resolved keyword location display name.

Example:

"Austin, Texas, United States"

created_at
string<date-time>
required
device
enum<string>
required
Available options:
desktop,
mobile
id
string
required
Pattern: ^kw_[a-z][a-z0-9]{23}$
Example:

"kw_a00000000000000000000000"

intent
string | null
required
language_code
string
required
Example:

"en"

language_label
string
required
Example:

"English"

latest_position
integer | null
required
location
string
required

Resolved keyword location display name.

Example:

"Austin, Texas, United States"

location_key
string
required

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

Example:

"ES/Andalusia/Malaga@en"

previous_position
integer | null
required
project_id
string
required
Pattern: ^prj_[a-z][a-z0-9]{23}$
Example:

"prj_a00000000000000000000000"

ranking_url
string | null
required
schedule
object | null
required
tags
string[]
required
target_url
string | null
required
text
string
required
Example:

"rank tracker api"

topic
string | null
required
updated_at
string<date-time>
required