Prepare an exact interval stored GA4 report
/sites/{site_id}/ga4/store/reports/{report_type}analytics:read, analytics:prepareRequires analytics:read and site access. JSON accepts window (preset or start/end object), limit, offset and optional report_set_id. Preparation queues missing data; it never calls Google inline. Repeating a request reuses durable work. Retain report_set_id for stable pagination.
| Request | POST https://satelliteai.io/api/v1/sites/{site_id}/ga4/store/reports/{report_type} |
| Permission | analytics:read, analytics:prepare |
| Response | A single object: data is object. |
| Operation ID | prepareGa4StoredReport |
More context and worked examples are in the developer guide.
Example request
curl --fail-with-body --request POST \
'https://satelliteai.io/api/v1/sites/123/ga4/store/reports/sessions_over_time' \
-H 'Content-Type: application/json' \
--data '{"window":{"start":"2026-01-01","end":"2026-10-25"},"limit":100,"offset":0}' \
-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 | |
report_typerequired | path | string |
Unknown or repeated query parameters return 400.
JSON request body
Send Content-Type: application/json. The request body is required. Fields below describe the request; response fields follow separately.
| Field | Type | Description |
|---|---|---|
window | string | object | |
window.start | string (date)required | |
window.end | string (date)required | |
limit | integer | Maximum records per page applied to this request. default 100 · min 1 · max 500 |
offset | integer | default 0 · min 0 · max 100000 |
report_set_id | integer | min 1 |
Data dictionary
Published report is ready
202: Preparation pending; retry the same request
[] 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.columns | array of string | |
data.rows | array of array of any | |
data.metadata | object | |
data.metadata.source | string | one of: stored |
data.metadata.state | string | one of: ready, pending, partial, unsupported, empty_period |
data.metadata.report_set_id | integernullable | |
data.metadata.binding_id | integer | |
data.metadata.start | string (date) | |
data.metadata.end | string (date) | |
data.metadata.timezone | string | |
data.metadata.quality | array of object | |
data.metadata.next_offset | integernullable | |
data.metadata.total_rows | integer |
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 |
|---|---|
503 | Store disabled or unavailable |