rank-checks

Get one rank check

Changed on Oct 19, 2026

get/rank-checks/{check_id}

Request

Base URL: https://eu.bisibility.com/api/v1
URL: https://eu.bisibility.com/api/v1/rank-checks/{check_id}
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:read)

Path parameters

check_idstring required

Example:check_a00000000000000000000000

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).

Response

JSON response

checked_atstring date-time required

cost_centsnumber nullable required

errorstring nullable required

error_codestring nullable required

Stable failure code for this check, or null for rows older than the code taxonomy.

idstring required

keyword_idstring required

observation_completeness'complete' | 'truncated_by_stop_on_match' | 'unknown' | 'null' nullable required

Persisted coverage, or null when legacy metadata is absent. Only complete coverage supports absence within depth; a valid positive rank remains valid with truncated coverage.

positioninteger nullable required

previous_positioninteger nullable required

providerstring required

ranking_urlstring nullable required

run_idstring nullable required

Rank-check run that produced this result, or null for a legacy row.

status'completed' | 'failed' | 'running' required

Example response

{
  "id": "check_a00000000000000000000000",
  "keyword_id": "kw_a00000000000000000000000",
  "run": {
    "id": "rcr_a00000000000000000000000"
  },
  "run_id": "rcr_a00000000000000000000000"
}

Changes

Oct 19, 2026a6e1ec0dec82 Revision changes
- breaking
  added the new path request parameter check_id
- 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

Operation history