signals

Ingest a project signal

Changed on
post/signals

Request

  • Base URL: https://eu.bisibility.com/api/v1
  • URL: https://eu.bisibility.com/api/v1/signals
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL /api/auth/oauth2/authorize, token URL /api/auth/oauth2/token, scopes: api:write)

Query parameters

projectstring

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.

Headers

Bisibility-API-Version'v1'

API contract version requested by the client. Omit this header to use the current backward-compatible behavior.

X-Bisibility-Projectstring

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.

X-Bisibility-Source'sdk' | 'cli' | 'mcp'

Declares the client that produced the request for usage reporting: sdk, cli or mcp. Optional; any other value counts as api. It never changes authentication or which budget applies (every bearer-authenticated request counts against the API, MCP and SDK budget).

Request body

happened_atstring date-time

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

keyword_idstring
payloadobject

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

severity'info' | 'warning' | 'critical'
source'deploy' | 'cms' | 'api' required
typestring required
urlstring uri

Example request

{
  "keyword_id": "kw_a00000000000000000000000",
  "type": "deploy.completed"
}

Response

Signal ingested

created_atstring date-time required
happened_atstring date-time required
idstring required
keyword_idstring nullable required
payloadobject nullable required

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

project_idstring required
public_idstring required
severity'info' | 'warning' | 'critical' required
source'rank_tracker' | 'search_analytics' | 'url_inspection' | 'sitemap' | 'deploy' | 'cms' | 'search_engine_status' | 'manual' | 'api' required
typestring required
urlstring uri nullable required

Example response

{
  "id": "sig_a00000000000000000000000",
  "keyword_id": "kw_a00000000000000000000000",
  "project_id": "prj_a00000000000000000000000",
  "public_id": "sig_a00000000000000000000000",
  "type": "deploy.completed"
}

Changes

    • info

      the endpoint scheme security AppOAuth was added to the API

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status