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_idstringRequiredformat: "objectid"
Unique identifier for a Site

Query parameters

statuslist of enumsOptional
Filter by public status. Repeat the parameter to match any of several statuses.
rulelist of enumsOptional
Filter by recommendation rule. Repeat the parameter to match any of several rules.
prioritylist of enumsOptional
Filter by priority. Repeat the parameter to match any of several priorities.
Allowed values:
topiclist of enumsOptional
Filter by topic. Repeat the parameter to match any of several topics.
pageIdstringOptionalformat: "objectid"
Filter to recommendations that target this page.
localeIdstringOptionalformat: "objectid"

Filter to recommendations for this locale. When the id is the site’s primary locale, rows with no localeId are included as well.

limitintegerOptional1-100Defaults to 50

Maximum number of recommendations to return. Defaults to 50, up to 100.

cursorstringOptional>=1 character

Opaque pagination cursor from a previous response’s nextCursor.

Response

Paginated list of recommendations
itemslist of objects
nextCursorstringOptional
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