Run a rank check

Error

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>"
}

{
  "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>"
}

{
  "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>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

POST

keywords

{id}

checks

Error

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>"
}

{
  "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>"
}

{
  "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>"
}

{
  "detail": "<string>",
  "docs_url": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "errors": "<unknown>"
}

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

async

boolean

When true, enqueue the check and return a running rank-check resource.

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.

Response

Rank check completed

attempts

object[] | null

required

Provider fallback attempts recorded before the final rank-check status.

Show child attributes

checked_at

string<date-time>

required

cost_cents

number | null

required

error

string | null

required

string

required

Pattern: ^check_[a-z][a-z0-9]{23}$

Example:

"check_a00000000000000000000000"

keyword_id

string

required

Pattern: ^kw_[a-z][a-z0-9]{23}$

Example:

"kw_a00000000000000000000000"

position

integer | null

required

previous_position

integer | null

required

provider

string

required

ranking_url

string | null

required

status

enum<string>

required

Available options:

completed,

failed,

running

Discovery

Account & Access

Projects

API Keys

Keywords

Rank Checks

Keyword Research

Backlinks

Domain Overview

Analytics

Alerts

Competitors

Sitemap Monitoring

Saved Keywords

Saved Views

Signals

Providers

Webhooks

Team

Migration

Authorizations

Headers

Query Parameters

Response