CLIENT API / V1 GOOGLE ANALYTICS 4

Read GA4 property and cached connection health

GET/sites/{site_id}/ga4/connectionanalytics:read

Read GA4 property and cached connection health. Only explicitly granted sites and permissions are accessible. No credentials or raw worker payloads are returned.

RequestGET https://satelliteai.io/api/v1/sites/{site_id}/ga4/connection
Permissionanalytics:read
ResponseA single object: data is Ga4ConnectionData.
Operation IDgetGa4Connection

More context and worked examples are in the developer guide.

Example request

cURL · Bash
curl --fail-with-body \
  'https://satelliteai.io/api/v1/sites/123/ga4/connection' \
  -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

NameInTypeDescription
site_idrequiredpathintegerAuthorized site id. Parent and site grants must also match.
min 1 · max 9223372036854775807

Unknown or repeated query parameters return 400.

Data dictionary

Scoped result. Lists return pagination metadata; unavailable records return 404. Connection and cached health metadata only. Optional fields can be absent or null; no Google credentials are returned.

[] 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
FieldTypeDescription
data.site_idintegernullableSite id.
data.ga4_property_idstringnullableGa4 property id.
data.ga4_property_namestringnullableGa4 property name.
data.property_idstringnullableProperty id.
data.property_namestringnullableProperty name.
data.connection_statusstringnullableConnection status.
data.connection_revisionintegernullableConnection revision.
data.active_binding_idintegernullableActive binding id.
data.last_health_atstringnullableLast health at.
data.last_error_codestringnullableLast error code.
data.updated_atstringnullableUpdated at.
data.site_urlstringnullableSite url.
data.connectedbooleanCached connection state; not a live provider health probe.
data.statusstringnot_connected when no connection is stored.
data.health_is_cachedbooleanTrue when cached health metadata is returned.

Response metadata

Fields in meta
FieldTypeDescription
meta.request_idstringalways presentRequest identifier; also returned in X-Request-ID. Include it in support requests.
meta.api_versionstringalways presentAPI version that produced the response.
one of: v1
meta.limitintegerMaximum records per page applied to this request.
min 1 · max 100
meta.has_morebooleanTrue when another page is available.
meta.next_cursorstringnullableOpaque cursor for the next page; send as cursor. Null on the last page.
meta.availabilitystringavailable when stored data exists; not_available when it does not.
one of: available, not_available
meta.billingobjectPresent for paid live SERP requests; replayed receipts describe the original debit, not an additional charge.
meta.billing.operationstringalways present
one of: client_api_serp_refresh
meta.billing.credits_chargedintegeralways present
min 0
meta.billing.transaction_idintegeralways present
meta.billing.replayedbooleanalways present

Error responses

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

HTTPWhen
400Invalid parameters
401Invalid credentials
403Missing permission
404Missing or inaccessible resource