A valid request URL is required to generate request examples{
"attempts": [
{
"message": "<string>",
"provider": "<string>"
}
],
"checked_at": "2023-11-07T05:31:56Z",
"cost_cents": 123,
"error": "<string>",
"id": "check_a00000000000000000000000",
"keyword_id": "kw_a00000000000000000000000",
"position": 123,
"previous_position": 123,
"provider": "<string>",
"ranking_url": "<string>",
"run_id": "rcr_a00000000000000000000000",
"status": "completed"
}{
"id": "rcr_a00000000000000000000000",
"status": "queued"
}{
"detail": "<string>",
"docs_url": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"errors": "<unknown>"
}{
"detail": "<string>",
"docs_url": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"errors": "<unknown>"
}{
"detail": "<string>",
"docs_url": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"errors": "<unknown>"
}{
"detail": "<string>",
"docs_url": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"errors": "<unknown>"
}{
"detail": "<string>",
"docs_url": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"errors": "<unknown>"
}{
"detail": "<string>",
"docs_url": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"errors": "<unknown>"
}Queue a rank check
Queues a one-item rank-check run unless inline execution is configured.
A valid request URL is required to generate request examples{
"attempts": [
{
"message": "<string>",
"provider": "<string>"
}
],
"checked_at": "2023-11-07T05:31:56Z",
"cost_cents": 123,
"error": "<string>",
"id": "check_a00000000000000000000000",
"keyword_id": "kw_a00000000000000000000000",
"position": 123,
"previous_position": 123,
"provider": "<string>",
"ranking_url": "<string>",
"run_id": "rcr_a00000000000000000000000",
"status": "completed"
}{
"id": "rcr_a00000000000000000000000",
"status": "queued"
}{
"detail": "<string>",
"docs_url": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"errors": "<unknown>"
}{
"detail": "<string>",
"docs_url": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"errors": "<unknown>"
}{
"detail": "<string>",
"docs_url": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"errors": "<unknown>"
}{
"detail": "<string>",
"docs_url": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"errors": "<unknown>"
}{
"detail": "<string>",
"docs_url": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"errors": "<unknown>"
}{
"detail": "<string>",
"docs_url": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>",
"errors": "<unknown>"
}Authorizations
Project-scoped API key. It cannot access account routes or create additional projects.
Headers
API contract version requested by the client. Omit this header to use the current backward-compatible behavior.
v1 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
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.
Response
Rank check completed when inline execution is enabled
Provider fallback attempts recorded before the final rank-check status.
Show child attributes
Show child attributes
^check_[a-z][a-z0-9]{23}$"check_a00000000000000000000000"
^kw_[a-z][a-z0-9]{23}$"kw_a00000000000000000000000"
Rank-check run that produced this result, or null for a legacy row.
^rcr_[a-z][a-z0-9]{23}$"rcr_a00000000000000000000000"
completed, failed, running