rank-checks

Get a rank-check run

Changed on

Read an existing run without launching a measurement.

get/projects/{project_id}/rank-check-runs/{run_id}

Request

  • Base URL: https://eu.bisibility.com/api/v1
  • URL: https://eu.bisibility.com/api/v1/projects/{project_id}/rank-check-runs/{run_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

project_idstring required

Public project ID; membership and token scope are enforced.

Example:prj_a00000000000000000000000
run_idstring required
Example:rcr_a00000000000000000000000

Headers

Bisibility-API-Version'v1'

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

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

idstring required
project_idstring required
statusstring required

Execution status; readers tolerate future values.

outcomestring nullable required
terminalboolean required
polling_statestring required

terminal, blocked, deferred, active, or unknown; no rank-check row is required.

triggerstring required
counts_basisstring required
keyword_countinteger required
target_countinteger required
planned_forstring date-time nullable required
launched_atstring date-time nullable required
started_atstring date-time nullable required
finished_atstring date-time nullable required
blocked_reasonstring nullable required
parent_run_idstring nullable required
cost_centsnumber nullable required

Example response

{
  "id": "rcr_a00000000000000000000000",
  "project_id": "prj_a00000000000000000000000",
  "parent_run_id": "rcr_a00000000000000000000000"
}

Changes

  • a6e1ec0dec82Revision changes
    • breaking

      added the new path request parameter project_id

    • breaking

      added the new path request parameter run_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