research-reports

Read a stored research report

Changed on

Read-only view of a report that is already stored. Reads never call a provider and never require a connected provider. A report is fresh while now is before fresh_until.

get/projects/{project_id}/research/reports/{kind}

Request

  • Base URL: https://eu.bisibility.com/api/v1
  • URL: https://eu.bisibility.com/api/v1/projects/{project_id}/research/reports/{kind}
  • 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
kind'backlinks' | 'domain_overview' | 'keyword_research' required

Report kind. The remaining query parameters are validated per kind.

Query parameters

targetstring

Stored target; required for backlinks and domain overviews.

target_scopestring

site or page for backlinks; root or subdomain for overviews.

modestring

Backlinks row mode or keyword research mode as stored.

include_subdomainsboolean

Backlinks include-subdomains flag as stored.

seedstring

Keyword research seed as stored. Required for keyword research.

include_clickstreamboolean

Keyword research clickstream flag as stored.

result_limit100 | 300 | 500

Keyword research result limit as stored.

connection_idstring

Provider connection public ID used when the report was stored.

language_codestring

Domain overview language code as stored.

location_codeinteger

Domain overview location code as stored.

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

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