List Recommendations
Lists a site's AEO recommendations, newest first, with cursor pagination.
Repeatable filters (`status`, `rule`, `priority`, `topic`) accept a single
value or multiple values via repeated query keys
(`status=active&status=dismissed`). Unsupported query parameters return
`400 validation_error`.
<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_id
Unique identifier for a Site
Query parameters
status
Filter by public status. Repeat the parameter to match any of several statuses.
rule
Filter by recommendation rule. Repeat the parameter to match any of several rules.
priority
Filter by priority. Repeat the parameter to match any of several priorities.
Allowed values:
topic
Filter by topic. Repeat the parameter to match any of several topics.
pageId
Filter to recommendations that target this page.
localeId
Filter to recommendations for this locale. When the id is the site’s
primary locale, rows with no localeId are included as well.
limit
Maximum number of recommendations to return. Defaults to 50, up to 100.
cursor
Opaque pagination cursor from a previous response’s nextCursor.
Response
Paginated list of recommendations
items
nextCursor
Opaque cursor for the next page. Omit when there are no more results.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error