Skip to navigation

Get Recommendations Summary

Returns site-level recommendation counts for active, applied, and dismissed statuses, each broken down by priority. This endpoint does not accept query parameters; unexpected keys return 400 validation_error.

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 counts by status and priority
activeobject

Total and priority counts for one public status. total equals the sum of byPriority.

appliedobject

Total and priority counts for one public status. total equals the sum of byPriority.

dismissedobject

Total and priority counts for one public status. total equals the sum of byPriority.

Errors

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