What's NewCloudZero Academy
API Reference
CloudZero Status

List recommendations

get
https://api.cloudzero.com/v2/optimize/recommendations

Gets recommendations for a specified organization in paginated form. This endpoint supports filtering, sorting, and grouping by various columns as well as searching. Note: The optimization_id field is deprecated. Use recommendation_type_id instead.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
status

Filter by status

recommendation_type_id

Minimum 30-day cost impact to include. Only recommendations with cost impact greater than or equal to this value are returned (default $1.00).

recommendation_type_name

Filter by recommendation type name.

category

Filter by recommendation category (e.g., optimization).

effort

Filter by effort level required to address the recommendation. Accepts: low, medium, high, not_set.

source

Filter by recommendation source (e.g., CloudZero, AWS: Trusted Advisor).

Minimum 30-day cost impact to include. Only recommendations with cost impact greater than or equal to this value are returned (default $1.00).

string

Specifies a column to group the recommendations by. The resulting data will contain the group by column, the total recommendations in the group, and the cost impact of the recommendations in the group.

string

Returns recommendations where at least one column contains a search term. Search terms are separated by spaces.

integer
≥ 1
Defaults to 60000

Number of recommendations to show per page (default: 60000)

integer
≥ 0
Defaults to 0

Number of recommendations to show per page (default: 60000)

string
enum
Defaults to cost_impact_last_30_days

Column to sort results by (default: cost_impact_last_30_days)

Allowed:
string
enum
Defaults to desc

Sort direction: asc (ascending) or desc (descending, default)

Allowed:

Opaque pagination cursor returned from a previous request. When provided, other filter and sort parameters are ignored.

Responses

Updated 24 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 24 days ago