---
title: "Get keyword metrics"
method: POST
path: "/projects/{project_id}/keyword-metrics"
tags: ["keyword-research"]
---

# Get keyword metrics

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

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

## Path parameters

- `project_id` string, required: Public project ID; membership and token scope are enforced.

## Headers

- `Bisibility-API-Version` 'v1'
- `X-Bisibility-Source` 'sdk' | 'cli' | 'mcp'

## Request body

- KeywordMetricsRequest
  - `connection_id` string
  - `estimate_only` boolean
  - `fresh` boolean
  - `include_clickstream` boolean
  - `keywords` string[], required
  - `max_cost_cents` integer

## Response `200`

JSON response

- KeywordMetricsResponse
  - `cached_count` integer, required
  - `connections` object[], required
    - `id` string, required
    - `label` string, required
    - `provider` string, required
  - `cost_cents` number, required
  - `estimate` boolean
  - `estimated_cost_cents` number
  - `fetched_at` string, date-time, required
  - `fetched_count` integer, required
  - `fetched_count_estimate` integer
  - `provider` string, required
  - `rows` object[], required
    - `keyword` string, required
    - `competition` number, nullable, required
    - `cpc_cents` integer, nullable, required
    - `difficulty` number, nullable, required
    - `intent` unknown, required
    - `monthly_trend` object[], required
      - `month` integer, required
      - `search_volume` number, nullable, required
      - `year` integer, required
    - `search_volume` number, nullable, required
  - `total_count` integer, required

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `402`: Deployment credits exhausted for a paid provider request
- `403`: Forbidden, or `byok_required`: the account runs paid provider work only on its own provider keys and none serves this request
- `404`: Not found
- `409`: Unsupported API version
- `422`: Unsupported provider location or provider reauthorization required
- `429`: Rate limited

## Changes

- **2026-10-19** `a6e1ec0dec82`: 1 breaking, 7 info
  - added the new path request parameter `project_id`
  - the endpoint scheme security `AppOAuth` was added to the API
  - media type `application/json` was changed to a more specific media type `application/problem+json` for the response status `400`
  - media type `application/json` was changed to a more specific media type `application/problem+json` for the response status `401`
  - …4 more

[Operation history](https://skmtc.dev/bisibility/apis/bisibility-public-api/changes/projects/:project_id/keyword-metrics/post.md)

---

[API](https://skmtc.dev/bisibility/apis/bisibility-public-api.md) · [All operations](https://skmtc.dev/bisibility/apis/bisibility-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bisibility/apis/bisibility-public-api/revisions/a6e1ec0dec82?raw)