rank-checks

List rank checks for a keyword

get/keywords/{keyword_id}/rank-checks

Request

  • Base URL: https://eu.bisibility.com/api/v1
  • URL: https://eu.bisibility.com/api/v1/keywords/{keyword_id}/rank-checks
  • 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

keyword_idstring required

Public keyword ID.

Example:kw_a00000000000000000000000

Query parameters

limitinteger

Maximum items to return. Defaults to 50.

cursorstring

Opaque v3 cursor returned as meta.next_cursor from the previous page.

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

Filter by persisted rank-check status.

sincestring date-time

Return checks at or after this ISO-8601 date-time.

untilstring date-time

Return checks at or before this ISO-8601 date-time.

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

Example response

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

Changes

No recorded changes to this operation across all 2 revisions of this API.