CLIENT API / V1 RECOMMENDATIONS & FIXES

Read Fix

GET/sites/{site_id}/fixes/{record_id}fixes:read

Read Fix. Only explicitly granted sites and permissions are accessible. No credentials or raw worker payloads are returned. Returns the same public fields as the corresponding list row. Missing, wrong-parent and inaccessible records return the same 404.

RequestGET https://satelliteai.io/api/v1/sites/{site_id}/fixes/{record_id}
Permissionfixes:read
ResponseA single object: data is Fix.
Operation IDgetFix

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/fixes/123' \
  -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
record_idrequiredpathintegerAuthorized record 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. Proposed code/content changes with their actual approval and application state. Reading a fix does not approve or apply it.

[] 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.idintegerSatellite identifier for this record.
data.site_idintegerSatellite site ID (from GET /sites).
data.page_idintegernullableSatellite page ID (from GET /sites/{site_id}/pages).
data.task_idinteger
data.fix_idstringnullable
data.original_codestringnullable
data.corrected_codestringnullable
data.original_textstringnullable
data.corrected_textstringnullable
data.explanationstringnullable
data.issue_summarystringnullable
data.affected_elementstringnullable
data.action_labelstringnullable
data.categorystringnullable
data.approval_statusstringnullable
data.fix_typestringnullable
data.verification_statusstringnullable
data.time_estimateintegernullable
data.fix_versionintegernullable
data.is_appliedbooleannullable
data.content_changebooleannullable
data.requires_approvalbooleannullable
data.approved_atstring (date-time)nullable
data.applied_atstring (date-time)nullable
data.verified_atstring (date-time)nullable
data.created_atstring (date-time)nullableWhen Satellite created the record (UTC, RFC 3339).
data.updated_atstring (date-time)nullableWhen Satellite last updated the record (UTC, RFC 3339).

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