Get Recommendation

Returns a single AEO recommendation for the site. Missing recommendations, cross-site ids, and malformed ids all return `404 aeo_recommendation_not_found` so existence is not revealed across sites. <Warning title="AEO recommendations entitlement required">This endpoint requires a workspace with the AEO recommendations entitlement.</Warning> Required scope | `sites:read`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

site_idstringRequiredformat: "objectid"
Unique identifier for a Site
recommendation_idstringRequiredformat: "objectid"
Unique identifier for an AEO recommendation

Response

A single recommendation
idstringformat: "objectid"
Recommendation id.
ruleenum
Recommendation rule that produced the diagnosis.
statusenum

Public lifecycle status. Internal pending and in_progress both map to generating.

priorityenum
Recommendation priority.
topicenum
Recommendation topic.
typeenum
Whether the recommendation closes a gap or surfaces an opportunity.
targetobject or null

Discriminated target for the recommendation. null when stored fields cannot be mapped to exactly one target family.

proposalobject or null

Typed suggested fix. null while the recommendation is still generating, failed, or the stored proposal cannot be parsed.

auditobject
Audit run that produced the recommendation.
createdOnstringformat: "date-time"
updatedOnstringformat: "date-time"
evidencestringOptional

Human-readable evidence for the diagnosis.

actionstringOptional
Suggested next action in plain language.
localeIdstringOptionalformat: "objectid"
Locale the recommendation belongs to, when localized.
actionedAtstringOptionalformat: "date-time"
When the recommendation entered a terminal actioned state.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error