Read SerpFinding
/sites/{site_id}/pages/{page_id}/serp-findings/{record_id}analysis:readRead SerpFinding. 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.
| Request | GET https://satelliteai.io/api/v1/sites/{site_id}/pages/{page_id}/serp-findings/{record_id} |
| Permission | analysis:read |
| Response | A single object: data is SerpFinding. |
| Operation ID | getSerpFinding |
More context and worked examples are in the developer guide.
Example request
curl --fail-with-body \
'https://satelliteai.io/api/v1/sites/123/pages/4567/serp-findings/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
| Name | In | Type | Description |
|---|---|---|---|
site_idrequired | path | integer | Authorized site id. Parent and site grants must also match. min 1 · max 9223372036854775807 |
page_idrequired | path | integer | Authorized page id. Parent and site grants must also match. min 1 · max 9223372036854775807 |
record_idrequired | path | integer | Authorized 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. A persisted SERP finding including its dismissal and archive state.
[] 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.id | integeralways present | Satellite identifier for this record. |
data.site_id | integeralways present | Satellite site ID (from GET /sites). |
data.page_id | integeralways present | Satellite page ID (from GET /sites/{site_id}/pages). |
data.url | string | Absolute URL as stored by Satellite. |
data.generated_at | string (date-time)nullable | |
data.updated_at | string (date-time)nullable | When Satellite last updated the record (UTC, RFC 3339). |
data.report_type | stringnullable | |
data.section_title | stringnullable | |
data.issue | stringnullable | |
data.current_state | stringnullable | |
data.recommendation | stringnullable | |
data.example | stringnullable | |
data.text_change | stringnullable | |
data.snippet_format | stringnullable | |
data.dismissal_reason | stringnullable | |
data.primary_type | stringnullable | |
data.lens | stringnullable | |
data.before_text | stringnullable | |
data.after_text | stringnullable | |
data.change_type | stringnullable | |
data.wcag_criterion | stringnullable | |
data.section_number | integernullable | |
data.impact | integernullable | |
data.is_archived | booleannullable | |
data.dismissed_at | string (date-time)nullable | |
data.applies_to | anynullable | Stored content JSON; shape varies with the analysis source. This field contains client-facing analysis content. |
data.affected_count | integernullable |
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 |