---
title: "Match tracked keywords"
method: POST
path: "/projects/{project_id}/keyword-matches"
tags: ["keywords"]
---

# Match tracked keywords

`POST /projects/{project_id}/keyword-matches`

## Request

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

- KeywordMatchRequest
  - `texts` string[], required

## Response `200`

JSON response

- KeywordMatchResponse
  - `data` KeywordMatch[], required
    - `keyword_id` string, required
    - `latest_position` integer, nullable, required
    - `matched_text` string, required: Trimmed, lowercase request text used to match this keyword.
    - `market` KeywordMatchMarket, required
      - `country_code` string, required
      - `device` 'desktop' | 'mobile', required
      - `language_code` string, required
      - `language_label` string, required
      - `location` string, required
      - `location_key` string, required
    - `previous_position` integer, nullable, required
    - `ranking_url` string, nullable, required: Ranking URL from the most recent executed check, or null when that check has no ranking URL or no check exists. Fetch the keyword resource to read latest_successful_check for the most recent completed observation and its coverage.
    - `text` string, required: Stored keyword text, which can differ from matched_text in case and whitespace.
  - `meta` object, required
    - `truncated_texts` string[], required: Normalized texts with more than 100 matching markets. Their returned rows are partial.

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `409`: Unsupported API version
- `429`: Rate limited

## Changes

- **2026-10-19** `a6e1ec0dec82`: 1 breaking, 6 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`
  - …3 more

[Operation history](https://skmtc.dev/bisibility/apis/bisibility-public-api/changes/projects/:project_id/keyword-matches/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)