Keyword-level Keyword Gap drilldown for a selected page.

GET

/api/v1/gsc-insights/keyword-gap-page-keywords

curl --request GET \
  --url 'https://sitechecker.pro/api/v1/gsc-insights/keyword-gap-page-keywords?project_id=12345&page_url=https%3A%2F%2Fexample.com%2Fwebsite-safety%2F&order_by=clicks_desc&limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• bearerAuth

Parameters

Query Parameters

project_id

required

integer

Example

12345

Project ID.

page_url

required

string

Example

https://example.com/website-safety/

Exact page URL (as returned by keyword-gap-pages).

date_from

string format: date

Start of the GSC window (inclusive). Default: last 30 days of final GSC data (UI parity).

date_to

string format: date

End of the GSC window (inclusive).

keyword

string

Keyword text search.

order_by

string

Example

clicks_desc

Sort as _asc|_desc: keyword, clicks, impressions, position.

limit

integer

default: 50 >= 1 <= 100

Page size.

offset

integer

0

Pagination offset.

Responses

200

Keyword rows with gap metrics and usage flags

Media typeapplication/json

object

data

Array<object>

Keyword Gap drilldown row for a selected page (same formulas and null semantics as the page rows).

object

keyword

Keyword/query.

string

clicks

GSC clicks.

integer

nullable

impressions

GSC impressions.

integer

nullable

position

Average position.

number format: float

nullable

ctr

CTR.

number format: float

nullable

lost_clicks

Estimated lost clicks: max(keyword_impressions * 0.2 - keyword_clicks, 0).

number format: float

nullable

count

Keyword occurrences in the page text (crawler).

integer

nullable

percent

Keyword occurrence percentage in the page text (crawler).

number format: float

nullable

used_in_title

Whether the keyword is used in the title.

boolean

nullable

used_in_description

Whether used in the meta description.

boolean

nullable

used_in_h1

Whether used in H1.

boolean

nullable

used_in_h2_h6

Whether used in H2-H6.

boolean

nullable

used_in_alt_tags

Whether used in image alt tags.

boolean

nullable

meta

GSC Insights meta block for list endpoints: scope echo + pagination (total/limit/offset).

object

project_id

Project ID.

integer

date_from

Selected period start.

string format: date

date_to

Selected period end.

string format: date

compare_from

Optional comparison period start.

string format: date

nullable

compare_to

Optional comparison period end.

string format: date

nullable

source_status

Source connection/data availability statuses keyed by source (e.g. gsc, ga4).

object

key

additional properties

string

data_freshness

Latest data date used per source (e.g. gsc_date, ga4_date).

object

key

additional properties

string

nullable

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

{
  "meta": {
    "project_id": 12345,
    "date_from": "2026-05-01",
    "date_to": "2026-05-31",
    "source_status": {
      "gsc": "connected",
      "ga4": "not_connected"
    },
    "data_freshness": {
      "gsc_date": "2026-06-30",
      "ga4_date": "2026-07-02"
    },
    "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."
  }
}

409

GSC not connected or Site Audit content data unavailable

Media typeapplication/json

Also returned as site_audit_data_unavailable on endpoints that join Site Audit page content.

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": "gsc_not_connected",
    "message": "Google Search Console is not connected for this project."
  }
}

422

Validation error or invalid date range

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."
  }
}