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
config
object
required
name
string
required
Required string length: 1 - 48
surface
enum<string>
Available options:
keywords,
competitors

Response

Created

config
object
required
id
string
required
Pattern: ^viw_[a-z][a-z0-9]{23}$
Example:

"viw_a00000000000000000000000"

name
string
required
surface
enum<string>
required
Available options:
keywords,
competitors