rank-checks

Export rank history

Changed on

Returns paginated JSON or streams CSV.

get/projects/{project_id}/exports/rank-history

Request

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

version'1' | '2'

V1 preserves legacy row/aggregation semantics. V2 returns shared qualified history and whole-scope metadata.

stream'observations' | 'attempts'
basis'observed_at' | 'recorded_at'
fromstring date-time
tostring date-time
aggregation'none'
format'csv' | 'json'
keyword_idstring[]
range'30' | '90' | 'all'
granularity'daily' | 'weekly'
cursorstring
limitinteger

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

Paginated JSON or complete bounded CSV rank history

OR

Example response

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

Changes

  • a6e1ec0dec82Revision changes
    • breaking

      added the new path request parameter project_id

    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 to the ///// response property oneOf list for the response status

    • 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

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the ///// response property oneOf list for the response status