Google AI Overview KPI snapshot for the selected period.

GET

/api/v1/ai-visibility/google-ai-overview/summary

curl --request GET \
  --url 'https://sitechecker.pro/api/v1/ai-visibility/google-ai-overview/summary?project_id=12345&date_from=2026-02-19&date_to=2026-05-19&device=desktop&ai_citation=all&ai_brand_mention=all' \
  --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-19

Start of the monitoring period (inclusive), ISO date (UTC).

date_to

required

string format: date

Example

2026-05-19

End of the monitoring period (inclusive), ISO date (UTC).

country

string

device

string

Allowed values: desktop mobile tablet

language

string

volume_min

integer

volume_max

integer

ai_citation

string

Allowed values: all with without

citation_url

string

citation_position_min

integer

citation_position_max

integer

ai_brand_mention

string

Allowed values: all with without

Responses

200

AIO summary KPIs

Media typeapplication/json

object

data

AI Overview KPI snapshot for the selected period/filters. Values are the as-of latest day in the range; citation visibility and average citation position are owner/host-scoped. keywords_with_owner_citation / keywords_with_brand_mention are derived as round(visibility / 100 * keywords_with_ai_overview).

object

ai_overview_share

Reusable OpenAPI response schemas for the Google AI Overview block of the AI Visibility Public API (summary / history / keywords / analysis / filter-values). One schema per endpoint response data. Property names mirror the exact keys the corresponding *Service builds, so the documented contract and the runtime response shapes stay in lock-step. The shared PaginationMeta / ErrorEnvelope schemas live in PublicApiSchemas and are referenced, not redefined.

number format: float

citation_visibility

number format: float

brand_mention_visibility

number format: float

avg_citation_position

number format: float

nullable

tracked_keywords_total

integer

keywords_with_ai_overview

integer

keywords_with_owner_citation

integer

keywords_with_brand_mention

integer

Example

{
  "data": {
    "ai_overview_share": 42.5,
    "citation_visibility": 18.75,
    "brand_mention_visibility": 12,
    "avg_citation_position": 3.4,
    "tracked_keywords_total": 1200,
    "keywords_with_ai_overview": 510,
    "keywords_with_owner_citation": 96,
    "keywords_with_brand_mention": 61
  }
}

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 or unsupported filter

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