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
​
X-Bisibility-Project
string

Project public ID (prj_...) targeted by this personal-access-token request. Optional. Selection precedence is: {project_id} path parameter, X-Bisibility-Project header, project query parameter, then inference when the PAT owner belongs to exactly one project. Project API keys and paths that already carry a project ID ignore it.

Query Parameters

​
project
string

Query-parameter equivalent of the X-Bisibility-Project header for personal-access-token project selection. Optional. Selection precedence is: {project_id} path parameter, X-Bisibility-Project header, project query parameter, then inference when the PAT owner belongs to exactly one project.

Body

application/json
​
source
enum<string>
required
Available options:
deploy,
cms,
api
​
type
string
required
Pattern: ^[a-z_]+\.[a-z_]+$
Example:

"deploy.completed"

​
happened_at
string<date-time>

ISO-8601 date-time when the signal happened. Defaults to now.

​
keyword_id
string
Pattern: ^kw_[a-z][a-z0-9]{23}$
Example:

"kw_a00000000000000000000000"

​
payload
object

JSON object payload. Ingestion rejects serialized payloads above 8KB.

​
severity
enum<string>
default:info
Available options:
info,
warning,
critical
​
url
string<uri>

Response

Signal ingested

​
created_at
string<date-time>
required
​
happened_at
string<date-time>
required
​
id
string
required
Pattern: ^sig_[a-z][a-z0-9]{23}$
Example:

"sig_a00000000000000000000000"

​
keyword_id
string | null
required
Pattern: ^kw_[a-z][a-z0-9]{23}$
Example:

"kw_a00000000000000000000000"

​
payload
object | null
required

JSON object payload. Ingestion rejects serialized payloads above 8KB.

​
project_id
string
required
Pattern: ^prj_[a-z][a-z0-9]{23}$
Example:

"prj_a00000000000000000000000"

​
public_id
string
required
Pattern: ^sig_[a-z][a-z0-9]{23}$
Example:

"sig_a00000000000000000000000"

​
severity
enum<string>
required
Available options:
info,
warning,
critical
​
source
enum<string>
required
Available options:
rank_tracker,
search_analytics,
url_inspection,
sitemap,
deploy,
cms,
search_engine_status,
manual,
api
​
type
string
required
Pattern: ^[a-z_]+\.[a-z_]+$
Example:

"deploy.completed"

​
url
string<uri> | null
required