get https://api.umbrellacost.io/api/v1/recommendations?filters[type]=ec2-idle
The call is used to retrieve the current live recommendations
Filtering recommendations can be applied to the above calls using query parameters in the following manner: filters[type]=recommendationType where recommendationType is one of the recommendation types supported. You can use the Get recommendation types call to get the possible types.
While each recommendation has different attributes that relate to the recommendation, they all share the following common fields:
| Name | Description |
|---|---|
| account_id | The payer account id |
| linked_account_id | The linked account id that the recommendation is relevant to (can be the payer account id also) |
| linked_account_name | The linked account name that the recommendation is relevant to (can be the payer account name also) |
| type | The recommendation type (See Recommendations Types Below) |
| total_cost_current | The corresponding monthly cost without executing the recommendation |
| total_cost_recommended | The corresponding monthly cost after executing the recommendation |
| potential_savings | The monthly savings percent in case the recommendation is executed |
| action | The general type of action related to the recommendation - Modify/Terminate/Upgrade/Delete/Buy |
| recommendation_creation_time | The time the recommendation was created |
| uuid | The recommendation id |
| recommendation_status_id | The recommendation status (See Recommendations Statuses Below) |
| recommendation_update_time | The time the recommendation was updated with one of the statuses. |
Recommendation Statuses
Available Recommendation Statuses are:
- Open Recommendation (Recommendation which no action have been made on it): Type ID: 0
- Completed Recommendation: Type ID: 1
- Excluded Recommendation (Recommendation which excluded action has been made on it): Type ID: 4