Skip to main content
GET
Error

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

limit
integer
default:50

Maximum rank checks to return. Defaults to 50.

Required range: 1 <= x <= 200
cursor
string

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

status
enum<string>

Filter by persisted rank-check status.

Available options:
completed,
failed,
running
since
string<date-time>

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

until
string<date-time>

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

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

JSON response

data
object[]
required
meta
object
required