Skip to main content
GET
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

Query Parameters

target
string
required

Domain for site scope or full URL for page scope.

target_scope
enum<string>
default:site
Available options:
site,
page
include_subdomains
boolean
default:true

Ignored when target_scope is page.

result_limit
enum<integer>
default:100
Available options:
100,
300,
500,
1000
mode
enum<string>
default:as_is

Provider-side row mode applied over the full corpus.

Available options:
as_is,
one_per_domain
estimate_only
boolean
default:false

Return a free cache-aware provider cost estimate without a paid call.

fresh
boolean
default:false
max_cost_cents
integer

Best-effort pre-estimate provider cost gate, in cents.

Required range: x >= 1

Response

JSON response

data
object
required