Skip to navigation
AEO Recommendations

Get Recommendation Settings

Returns the site’s AEO recommendation settings, including the fully resolved per-rule toggle map and whether recurring audits are enabled.

This is a read-only resolve. It does not create or mutate a settings document (sites:read alone never writes). A never-configured site still returns 200 with catalog-default ruleConfig and recurringAuditsEnabled: false; createdOn / updatedOn are omitted until a document is persisted.

AEO recommendations entitlement required
This endpoint requires a workspace with the AEO recommendations entitlement.

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

Response

Recommendation settings for the site (defaults when never configured)

ruleConfigobject

Fully resolved per-rule toggles. Every recommendation rule is present.

recurringAuditsEnabledboolean
Whether recurring audits are enabled. Always present on the wire.
lastAuditedOnstringOptionalformat: "date-time"
When the site was last audited.
createdOnstringOptionalformat: "date-time"

When the settings document was created. Omitted when no settings document exists yet (never-configured site).

updatedOnstringOptionalformat: "date-time"

When the settings document was last updated. Omitted when no settings document exists yet (never-configured site).

Errors

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