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
keywords
string[]
required
Required array length: 1 - 700 elements
Required string length: 1 - 80
connection_id
string
Pattern: ^conn_[a-z][a-z0-9]{23}$
estimate_only
boolean
default:false
fresh
boolean
default:false
include_clickstream
boolean
default:false
max_cost_cents
integer
Required range: x >= 1

Response

JSON response

cached_count
integer
required
Required range: x >= 0
connections
object[]
required
cost_cents
number
required
Required range: x >= 0
fetched_at
string<date-time>
required
fetched_count
integer
required
Required range: x >= 0
provider
string
required
rows
object[]
required
total_count
integer
required
Required range: x >= 0
estimate
boolean
estimated_cost_cents
number
Required range: x >= 0
fetched_count_estimate
integer
Required range: x >= 0