CLIENT API / V1 GOOGLE ANALYTICS 4
List stored GA4 dataset dimensions and metrics
GET
/sites/{site_id}/ga4/datasetsanalytics:readOVERVIEW
List stored GA4 dataset dimensions and metrics. 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/datasets |
| Permission | analytics:read |
| Response | A single object: data is Ga4DatasetsData. |
| Operation ID | getGa4Datasets |
More context and worked examples are in the developer guide.
REQUEST
Example request
curl --fail-with-body \
'https://satelliteai.io/api/v1/sites/123/ga4/datasets' \
-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 |
Unknown or repeated query parameters return 400.
RESPONSE
Data dictionary
Scoped result. Lists return pagination metadata; unavailable records return 404.
[] 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.datasets | array of object | |
data.datasets[].name | string | Canonical dataset name. |
data.datasets[].dimensions | array of string | |
data.datasets[].metrics | array of string | |
data.datasets[].definition_version | integer | Current storage definition version. |
data.datasets[].core | boolean | Whether the dataset belongs to the core collection set. |
data.datasets[].supports_exact_range | boolean | Supports exact interval publication. |
data.datasets[].supports_public_prepare | boolean | May be requested by the public preparation call. |
data.datasets[].requires_page_filter | boolean | Requires an explicit page group, unavailable through the public preparation tool. |
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 |
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 |