keyword-research

Research keywords

Changed on

Researches or estimates keywords from one seed and requires write scope. estimate_only=true needs only read scope and never spends provider budget.

get/projects/{project_id}/keyword-research

Request

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

Path parameters

project_idstring required

Public project ID; membership and token scope are enforced.

Example:prj_a00000000000000000000000

Query parameters

seedstring required
mode'auto' | 'related' | 'suggestions' | 'ideas'
result_limit100 | 300 | 500
connection_idstring
include_clickstreamboolean

Use clickstream-refined volume metrics. Provider cost is doubled.

freshboolean
estimate_onlyboolean

Return a free cache-aware provider cost estimate without a lookup.

max_cost_centsinteger

Best-effort maximum provider cost for this request, in cents.

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

OR

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

    • info

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