analytics

Get a numeric project overview

Changed on
get/projects/{project_id}/overview

Request

  • Base URL: https://eu.bisibility.com/api/v1
  • URL: https://eu.bisibility.com/api/v1/projects/{project_id}/overview
  • 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

project_idstring required

Public project ID; membership and token scope are enforced.

Example:prj_a00000000000000000000000

Query parameters

range'7d' | '28d' | '90d'

Rank-history window used for overview comparisons.

device'all' | 'desktop' | 'mobile'

Filter tracked keywords by SERP device.

tagstring

Filter tracked keywords by exact tag name.

Headers

Bisibility-API-Version'v1'

API contract version requested by the client. Omit this header to use the current backward-compatible behavior.

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

average_positionnumber nullable required

Mean current position among keywords with ranked observations.

average_position_deltanumber nullable required

Previous mean position minus current mean position.

keywords_added_this_monthinteger required
last_check_atstring date-time nullable required
next_check_atstring date-time nullable required
project_idstring required
top_3_countinteger nullable required
top_10_countinteger nullable required
top_10_deltainteger nullable required
top_100_countinteger nullable required
tracked_keyword_countinteger required
visibilitynumber nullable required

Visibility measures volume-weighted ranking strength in Google's Top 20. 100 means every measured keyword ranks #1. Rankings below #20 do not add Visibility. Shallow or failed checks are not treated as lost rankings.

visibility_deltanumber nullable required

Visibility change in percentage points.

Example response

{
  "project_id": "prj_a00000000000000000000000"
}

Changes

  • a6e1ec0dec82Revision changes
    • breaking

      added the new path request parameter project_id

    • info

      the endpoint scheme security AppOAuth was added to the API

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status