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

Query Parameters

range
enum<string>
default:28d

Rank-history window used for overview comparisons.

Available options:
7d,
28d,
90d
device
enum<string>
default:all

Filter tracked keywords by SERP device.

Available options:
all,
desktop,
mobile
tag
string

Filter tracked keywords by exact tag name.

Maximum string length: 48

Response

JSON response

average_position
number | null
required

Mean current position among keywords with ranked observations.

average_position_delta
number | null
required

Previous mean position minus current mean position.

keywords_added_this_month
integer
required
Required range: x >= 0
last_check_at
string<date-time> | null
required
next_check_at
string<date-time> | null
required
position_distribution
object[]
required
project_id
string
required
Pattern: ^prj_[a-z][a-z0-9]{23}$
Example:

"prj_a00000000000000000000000"

top_10_count
integer | null
required
Required range: x >= 0
top_10_delta
integer | null
required
top_100_count
integer | null
required
Required range: x >= 0
top_3_count
integer | null
required
Required range: x >= 0
tracked_keyword_count
integer
required
Required range: x >= 0
visibility
number | null
required

Volume-weighted visibility percentage.

Required range: 0 <= x <= 100
visibility_delta
number | null
required

Visibility change in percentage points.