Keyword x competitors position matrix.

GET

/api/v1/competitor_keywords

curl --request GET \
  --url 'https://sitechecker.pro/api/v1/competitor_keywords?project_id=12345&date_from=2026-02-22&date_to=2026-05-22&search_engine=google&device=desktop&location_id=loc_TmV3IFlvcms&language_code=en&group_id=SG9tZSBQYWdlcw&rankings=all&movement_window=1d&serp_feature=ads&fields=cpc&limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• bearerAuth

Parameters

Query Parameters

project_id

required

integer

Example

12345

Project ID.

date_from

required

string format: date

Example

2026-02-22

Start of the Rank Tracker date range (inclusive, Y-m-d). Clamped to the project’s available indicator dates.

date_to

required

string format: date

Example

2026-05-22

End of the Rank Tracker date range (inclusive, Y-m-d). Visibility-style fields are snapshots for the latest available check within this range (as_of_date).

keyword

string

Substring keyword text search.

tracked_keyword_id

integer

Direct lookup of one tracked keyword row.

search_engine

string

Example

google

Search engine machine value from rank_tracker_filter_values (e.g. google).

device

string

Allowed values: desktop mobile tablet

Device filter.

location_id

string

Example

loc_TmV3IFlvcms

Opaque location id from rank_tracker_filter_values tracking_profiles (loc_… value).

language_code

string

Example

en

Language code (ISO alpha-2) from rank_tracker_filter_values.

group_id

string

Example

SG9tZSBQYWdlcw

Keyword group id from the groups endpoint (opaque value).

competitor_id

integer

Return matrix data for one tracked competitor (id from competitor_domains). The main domain row is always included.

rankings

string

default: all

Allowed values: all top_1 top_3 top_10 top_30 top_50 top_100 no_position moved_up moved_down not_changed

Ranking filter. Bucket filters are cumulative (top_10 = positions 1-10); response distribution buckets are exclusive. Movement filters (moved_up/moved_down/not_changed) compare against the movement_window snapshot.

movement_window

string

default: 7d

Allowed values: 1d 7d 30d 90d all_time

Comparison window for movement rankings filters. Only valid with rankings=moved_up, moved_down or not_changed. Default: 7d.

serp_feature

string

Allowed values: ads featured_snippet people_also_ask shopping top_carousel video

Filter keywords whose SERP contains the feature.

volume_from

integer

Minimum search volume.

volume_to

integer

Maximum search volume.

fields

string

Allowed values: cpc serp_features

Comma-separated extra keyword metadata: cpc, serp_features.

order_by

string

Sort as “_asc” or “_desc”. Sortable fields: keyword, volume.

limit

integer

default: 50 >= 1 <= 50

Page size. Rank Tracker list endpoints cap at 50 rows per request.

offset

integer

0

Pagination offset.

Responses

200

Paginated keyword rows with domain positions

Media typeapplication/json

object

data

Array<object>

Keyword x competitors matrix row. domains[] lists the main domain first; position_change is positive when the domain moved up over the selected range.

object

tracked_keyword_id

integer

keyword

string

search_engine

string

nullable

device

string

nullable

location_id

string

nullable

location_name

string

nullable

country_code

string

nullable

country_name

string

nullable

language_code

string

nullable

language_name

string

nullable

volume

integer

nullable

cpc

Only with fields=cpc.

number format: float

nullable

serp_features

Only with fields=serp_features.

Array<string>

nullable

domains

Array<object>

object

domain

string

is_main_domain

boolean

competitor_id

integer

nullable

position

integer

nullable

position_change

integer

nullable

meta

object

total

Reusable OpenAPI response schemas for the Public REST API: the error/meta envelope and one item schema per resource. Property names come from the Field registry so the documented contract and the runtime response shapes stay in lock-step.

integer

limit

integer

offset

integer

Example

{
  "data": [
    {
      "tracked_keyword_id": 123456,
      "keyword": "ai overview checker",
      "search_engine": "google",
      "device": "desktop",
      "volume": 30,
      "cpc": 11.75,
      "domains": [
        {
          "domain": "sitechecker.pro",
          "is_main_domain": true,
          "competitor_id": 456,
          "position": 2,
          "position_change": 11
        }
      ]
    }
  ],
  "meta": {
    "total": 137,
    "limit": 50,
    "offset": 0
  }
}

401

Missing or invalid API key

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

403

No active API entitlement for the account, or the project belongs to another account

Media typeapplication/json

Returned as api_access_denied when the account has no active API entitlement, and as forbidden when the requested project belongs to another account.

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "api_access_denied",
    "message": "API access is not available: the account has no active API entitlement."
  }
}

404

Project not found

Media typeapplication/json

The exact missing resource is in error.code: project_not_found, segment_not_found, crawl_not_found, keyword_not_found, opportunity_not_found, snapshot_unavailable or not_found.

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "project_not_found",
    "message": "Project not found."
  }
}

422

Validation error

Media typeapplication/json

Rejected query parameters. error.code is validation_error for parameter validation, or invalid_date_range / invalid_filter / invalid_event_type / unsupported_filter / unsupported_dimension / unsupported_scope / segment_filter_unsupported for module-specific rules.

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "validation_error",
    "message": "project_id is required."
  }
}

429

Rate limit exceeded — retry after the interval in the Retry-After header

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again later."
  }
}

500

Internal server error

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: validation_error bad_request project_not_found segment_not_found forbidden crawl_in_progress not_found upstream_error unauthorized rate_limit_exceeded api_access_denied internal_error crawl_not_found invalid_date_range invalid_filter invalid_event_type keyword_not_found opportunity_not_found snapshot_unavailable gsc_not_connected ga4_not_connected site_audit_data_unavailable ga4_data_unavailable unsupported_filter unsupported_dimension segment_filter_unsupported unsupported_scope ai_overview_data_unavailable prompt_data_unavailable

message

required

string

Example

{
  "error": {
    "code": "internal_error",
    "message": "Internal server error."
  }
}