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

Body

application/json
​
city
string | null
​
country
enum<string>

Optional country selector when location_key is omitted. Provide together with device.

Available options:
United States,
United Kingdom,
Canada,
Australia,
Germany,
France,
Spain,
Italy,
Netherlands,
Sweden,
Poland,
Ireland,
Portugal,
Belgium,
Switzerland,
Austria,
Denmark,
Norway,
Finland,
Brazil,
Mexico,
India,
Japan,
Singapore,
New Zealand,
South Africa,
United Arab Emirates
Example:

"United States"

​
cron_expression
string | null
​
device
enum<string>

Optional device selector. Provide with country when location_key is omitted; with location_key it overrides the current default device.

Available options:
desktop,
mobile
​
frequency
enum<string>
Available options:
paused,
manual,
daily,
weekly,
monthly,
custom_cron
​
jitter_minutes
integer

Whole-minute random delay from 0 to 120. Set 0 to disable jitter.

Required range: 0 <= x <= 120
​
location_key
string

Updates the default market from a canonical location key. Country and city are resolved from the location catalog; device defaults to the current default device when omitted.

Example:

"ES/Andalusia/Malaga@en"

​
serp_stop_on_match
boolean

Set false to fetch the full configured depth for competitor snapshots.

​
timezone
string

IANA time zone that anchors monthly and custom cron wall-clock schedules. Daily and weekly use a stable keyword-specific interval phase that timezone does not move.

Response

JSON response

​
city
string | null
required
​
country
enum<string>
required

Persisted default country for new keywords.

Available options:
United States,
United Kingdom,
Canada,
Australia,
Germany,
France,
Spain,
Italy,
Netherlands,
Sweden,
Poland,
Ireland,
Portugal,
Belgium,
Switzerland,
Austria,
Denmark,
Norway,
Finland,
Brazil,
Mexico,
India,
Japan,
Singapore,
New Zealand,
South Africa,
United Arab Emirates
Example:

"United States"

​
cron_expression
string | null
required
​
device
enum<string>
required

Persisted default device for new keywords and moved default-market keywords.

Available options:
desktop,
mobile
​
frequency
enum<string>
required
Available options:
paused,
manual,
daily,
weekly,
monthly,
custom_cron
​
jitter_minutes
integer
required

Whole-minute random delay from 0 to 120. Set 0 to disable jitter.

Required range: 0 <= x <= 120
​
last_checked_at
string<date-time> | null
required
​
location_key
string
required

Persisted canonical location key for the default market.

Example:

"ES/Andalusia/Malaga@en"

​
next_check_at
string<date-time> | null
required
​
project_id
string
required
Pattern: ^prj_[a-z][a-z0-9]{23}$
Example:

"prj_a00000000000000000000000"

​
serp_depth
enum<integer>
required
Available options:
10,
20,
50,
100
​
serp_stop_on_match
boolean
required

Stops a SERP crawl after the tracked domain is found.

​
source
enum<string>
required

How the effective default market was selected.

Available options:
derived,
explicit,
fallback
​
timezone
string
required

IANA time zone that anchors monthly and custom cron wall-clock schedules. Daily and weekly use a stable keyword-specific interval phase that timezone does not move.

​
updated_at
string<date-time> | null