Read Search Console coverage

GET/sites/{site_id}/search-console/coveragesearch-console:read

OVERVIEW

Read Search Console coverage. Only explicitly granted sites and permissions are accessible. No credentials or raw worker payloads are returned.

Request	`GET https://satelliteai.io/api/v1/sites/{site_id}/search-console/coverage`
Permission	`search-console:read`
Response	A single object: `data` is `SearchConsoleCoverageData`.
Operation ID	`getSearchConsoleCoverage`

More context and worked examples are in the developer guide.

REQUEST

Example request

cURL · Bash

curl --fail-with-body \
  'https://satelliteai.io/api/v1/sites/123/search-console/coverage' \
  -H "Authorization: Bearer $SATELLITE_API_KEY"

Replace the example IDs with values returned by the discovery endpoints. Example values are placeholders, not real records.

Parameters

Name	In	Type	Description
`site_id`required	path	integer	Authorized site id. Parent and site grants must also match. min 1 · max 9223372036854775807
`days`	query	integer	Number of Pacific-local calendar days, default 28, maximum 480. Mutually exclusive with start_date/end_date. default 28 · min 1 · max 480
`start_date`	query	string (date)	Inclusive YYYY-MM-DD date. Supply both endpoints of an ordered interval; no future dates. At most 480 days, mutually exclusive with days; Pacific-local dates.
`end_date`	query	string (date)	Inclusive YYYY-MM-DD date. Supply both endpoints of an ordered interval; no future dates. At most 480 days, mutually exclusive with days; Pacific-local dates.
`search_type`	query	string	Search Console search type; default web. one of: web, image, video, news, discover, googleNews · default web

Unknown or repeated query parameters return 400.

RESPONSE

Data dictionary

Scoped result. Lists return pagination metadata; unavailable records return 404. Stored coverage only; no Google call. Dates use America/Los_Angeles. Unsupported responses omit date lists.

[] marks an array element. nullable means the value can be null; treat it as unknown, not zero. always present means the key is always included in the object.

Fields in data
Field	Type	Description
`data.site_id`	integernullable	Site id.
`data.property_url`	stringnullable	Property url.
`data.search_type`	stringnullable	Search type.
`data.start_date`	stringnullable	Start date.
`data.end_date`	stringnullable	End date.
`data.source`	stringnullable	Source.
`data.timezone`	stringnullable	Timezone.
`data.fetched_at`	stringnullable	Fetched at.
`data.state`	string	one of: complete, partial, missing, unsupported
`data.stored_dates`	array of string (date)
`data.missing_dates`	array of string (date)
`data.reason`	string	Explanation when property-wide stored totals cannot represent the authorized site.

Response metadata

Fields in meta
Field	Type	Description
`meta.request_id`	stringalways present	Request identifier; also returned in X-Request-ID. Include it in support requests.
`meta.api_version`	stringalways present	API version that produced the response. one of: v1
`meta.limit`	integer	Maximum records per page applied to this request. min 1 · max 100
`meta.has_more`	boolean	True when another page is available.
`meta.next_cursor`	stringnullable	Opaque cursor for the next page; send as cursor. Null on the last page.
`meta.availability`	string	available when stored data exists; not_available when it does not. one of: available, not_available
`meta.billing`	object	Present for paid live SERP requests; replayed receipts describe the original debit, not an additional charge.
`meta.billing.operation`	stringalways present	one of: client_api_serp_refresh
`meta.billing.credits_charged`	integeralways present	min 0
`meta.billing.transaction_id`	integeralways present
`meta.billing.replayed`	booleanalways present

ERRORS

Error responses

Errors return {"error": {"code", "message", "request_id"}}. See error handling for retry guidance.

HTTP	When
`400`	Invalid parameters
`401`	Invalid credentials
`403`	Missing permission
`404`	Missing or inaccessible resource