Sign in

v1

latestOpenAPI 3.1.0BSD-32026-07-2471176175.5 KB
recommendations

List 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.

get/v2/optimize/recommendations

Query parameters

statusStatus[] nullable

Filter by status

Filter by status

recommendation_type_idstring[] nullable

Filter by recommendation type ID (e.g., CIR-AWS-00216).

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_namestring[] nullable

Filter by recommendation type name.

categorystring[] nullable

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

effortstring[] nullable

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

sourcestring[] nullable

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

number
OR
string
group_bystring

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.

searchstring

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

limitinteger

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

offsetinteger

Number of recommendations to skip for pagination (default 0)

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

sort_key'cost_impact_last_30_days'

Column to sort results by (default: cost_impact_last_30_days)

sort_order'desc'

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

cursorstring binary nullable

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

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

Response

Successful Response

columnsstring[]

The columns in the response

multiple_value_columnsstring[]

Columns in the response that are an array of values

display_namesobject

A mapping of column names to display names

Example response

{
  "recommendations": [
    {
      "recommendation_id": "rec-12345",
      "title": "Rightsize EC2 instance",
      "category": "optimization",
      "optimization_id": "CIR-AWS-00216",
      "recommendation_type_id": "CIR-AWS-00216",
      "source": "CloudZero",
      "effort": "low",
      "status": "not_started",
      "cost_impact_last_30_days": 150
    }
  ]
}