Skip to content
Sitechecker API documentationSitechecker API documentationSitechecker API

Per-keyword on-demand AI Overview analysis (source list + optional snippet).

GET
/api/v1/ai-visibility/google-ai-overview/analysis
curl --request GET \
  --url 'https://sitechecker.pro/api/v1/ai-visibility/google-ai-overview/analysis?project_id=12345&tracked_keyword_id=1&date=2026-04-15' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
project_id
required
integer
Example
12345

Project ID.

tracked_keyword_id
required
integer
date
required
string format: date
fields

Set to “snippet” to include the full AI Overview snippet text.

string

Responses

Section titled “Responses”

200

Section titled “200”

AI Overview analysis

Media typeapplication/json
object
data

On-demand per-keyword AI Overview check (live upstream call, not stored). empty_reason is no_ai_overview when there is no AI Overview for the keyword+date, no_sources when there is an overview without a source list, otherwise null. snippet_text is present only with fields=snippet.

object
tracked_keyword_id
integer
keyword
string
nullable
search_engine
string
nullable
device
string
country
string
nullable
language
string
nullable
check_date
string format: date
has_ai_overview
boolean
has_sources
boolean
empty_reason
string
nullable
Allowed values: no_ai_overview no_sources
owner_citation_position
integer
nullable
your_citations_count
integer
sources_total
integer
unique_sources_count
integer
your_citation_share
number format: float
brand_mention_count
integer
sources
Array<object>
object
position
integer
url
string
nullable
anchor
string
nullable
snippet
string
nullable
is_yours
boolean
snippet_text

Only with fields=snippet. Full AI Overview snippet text.

string
Example
{
  "data": {
    "tracked_keyword_id": 123456,
    "keyword": "ai overview checker",
    "search_engine": "google",
    "device": "desktop",
    "country": "US",
    "language": "en",
    "check_date": "2026-05-22",
    "has_ai_overview": true,
    "has_sources": true,
    "empty_reason": "no_ai_overview",
    "owner_citation_position": 2,
    "your_citations_count": 1,
    "sources_total": 8,
    "unique_sources_count": 7,
    "your_citation_share": 12.5,
    "brand_mention_count": 0,
    "sources": [
      {
        "position": 1,
        "url": "https://example.com/page",
        "anchor": "Example page",
        "is_yours": false
      }
    ]
  }
}

401

Section titled “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

Section titled “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

Section titled “404”

Project or keyword 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

Section titled “409”

Google AI Overview data is not available for this project yet

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": "ai_overview_data_unavailable",
    "message": "Google AI Overview data is not available for this project yet. Try again after the next SERP sync."
  }
}

422

Section titled “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

Section titled “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

Section titled “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."
  }
}

502

Section titled “502”

Upstream SERP data service 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": "upstream_error",
    "message": "The upstream SERP data service is temporarily unavailable. Try again later."
  }
}