Skip to main content
POST
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
estimate_only
boolean
default:false
required
language_code
string
required
Required string length: 2 - 12
location_code
integer
required
Required range: x >= 1
target
string
required
Required string length: 1 - 253
fresh
boolean
default:false
keyword_limit
integer
default:100
Required range: 1 <= x <= 100
max_cost_cents
integer

Required for paid analysis; estimate_only may omit it.

Required range: x >= 0
page_limit
integer
default:100
Required range: 1 <= x <= 1000
scope_override
enum<string>
Available options:
root,
subdomain

Response

JSON response

data
object
required