keyword-research

Get keyword metrics

Changed on

Gets or estimates metrics for up to 700 keywords and requires write scope.

post/projects/{project_id}/keyword-metrics

Request

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

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).

Request body

connection_idstring
estimate_onlyboolean
freshboolean
include_clickstreamboolean
keywordsstring[] required
max_cost_centsinteger

Response

JSON response

cached_countinteger required
cost_centsnumber required
estimateboolean
estimated_cost_centsnumber
fetched_atstring date-time required
fetched_countinteger required
fetched_count_estimateinteger
providerstring required
total_countinteger required

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

    • info

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