Read stored GA4 date coverage for all datasets
/sites/{site_id}/ga4/coverageanalytics:readRead stored GA4 date coverage for all datasets. 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}/ga4/coverage |
| Permission | analytics:read |
| Response | A single object: data is Ga4CoverageData. |
| Operation ID | getGa4Coverage |
More context and worked examples are in the developer guide.
Example request
curl --fail-with-body \
'https://satelliteai.io/api/v1/sites/123/ga4/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_idrequired | path | integer | Authorized site id. Parent and site grants must also match. min 1 · max 9223372036854775807 |
window | query | string | Property-local completed dates: 1d–366d, current_month/mtd, previous_month, previous_quarter, ytd, or YYYY-MM-DD/YYYY-MM-DD (at most 366 days). default 30d · example previous_month |
Unknown or repeated query parameters return 400.
Data dictionary
Scoped result. Lists return pagination metadata; unavailable records return 404. Stored coverage in the connected property timezone. This call does not start collection.
[] 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.
| Field | Type | Description |
|---|---|---|
data.site_id | integernullable | Site id. |
data.binding_id | integernullable | Binding id. |
data.property_id | stringnullable | Property id. |
data.timezone | stringnullable | Timezone. |
data.start | stringnullable | Start. |
data.end | stringnullable | End. |
data.state | stringnullable | State. |
data.source | stringnullable | Source. |
data.datasets | map of object | Map keyed by dataset name. Empty when state is empty_period. |
data.datasets.{key}.capability | string | Stored dataset capability or awaiting_collection. |
data.datasets.{key}.missing_dates | array of string (date) | Requested dates without current published facts. |
data.datasets.{key}.limited_dates | array of string (date) | Published dates with limited quality. |
data.datasets.{key}.fetched_at | stringnullable | Fetched at. |
data.datasets.{key}.data_through | stringnullable | Data through. |
data.datasets.{key}.attempt_state | stringnullable | Attempt state. |
data.datasets.{key}.next_retry_at | stringnullable | Next retry at. |
Response metadata
| 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 |
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 |