Skip to content

Time-series points for selected Search Conversion metrics.

GET
/api/v1/gsc-insights/search-conversion-history
curl --request GET \
--url 'https://sitechecker.pro/api/v1/gsc-insights/search-conversion-history?project_id=12345&date_from=2026-02-19&date_to=2026-05-19&metrics=clicks%2Csessions%2Ckey_events&compare_from=2026-01-01&compare_to=2026-01-31&history_grouping=daily&segment_id=all_pages&device=desktop&country=usa' \
--header 'Authorization: Bearer <token>'
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).

metrics
required
string
Example
clicks,sessions,key_events

Comma-separated metrics: clicks, impressions, ctr, average_position, ranked_keywords, ranked_pages, sessions, bounce_rate, average_session_duration, key_events, session_key_event_rate, potential_clicks, potential_key_events.

compare_from
string format: date
Example
2026-01-01

Start of the manual comparison period (inclusive). Must be passed together with compare_to; the response switches to nested current/previous/change blocks.

compare_to
string format: date
Example
2026-01-31

End of the manual comparison period (inclusive). Must be passed together with compare_from.

history_grouping
string
default: daily
Allowed values: daily weekly monthly

Time bucket for history points.

segment_id
string
Example
all_pages

Optional segment scope filter.

device
string
Allowed values: desktop mobile tablet

Filter the underlying GSC rows by device before aggregation.

country
string
Example
usa

Filter the underlying GSC rows by country (ISO-3166-1 alpha-3, lowercase) before aggregation. Use values from gsc_insights_filter_values.

page
string

Page URL text search applied to the underlying rows.

History points with the requested metric keys (+ previous_points with compare)

Media typeapplication/json
object
data

History payload: points (+ previous_points with compare; series[] per brand type with group_by=brand). Point keys follow the requested metrics.

object
points
Array<object>
object
date

Point date / period start.

string format: date
clicks

Clicks.

integer
impressions

Impressions.

integer
ctr

CTR.

number format: float
nullable
average_position

Average position.

number format: float
nullable
previous_points

Comparison overlay points; present when compare params are used.

Array<object>
nullable
object
series

Per-series points when group_by=brand splits the data into brand / non-brand.

Array<object>
nullable
object
meta

Standard GSC Insights meta block: request scope echo, source availability and data freshness. Extended per endpoint (history_grouping, resolved_compare_*, ga4_channel_scope…).

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
Example
{
"data": {
"points": [
{
"date": "2026-05-01",
"clicks": 120,
"impressions": 3050,
"ctr": 3.93,
"average_position": 12.4
}
]
},
"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"
}
}
}

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

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

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

Google Search Console is not connected

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

Validation error, invalid date range or invalid 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."
}
}

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

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