UMumbrellacost
Recommendations

Get Recommendations 2.0

Retrieves recommendations according to status and other filters

post/api/v2/recommendations/list

Request

  • Base URL
    https://api.umbrellacost.io
  • URL
    https://api.umbrellacost.io/api/v2/recommendations/list
  • Auth
    none declared. Required headers: Authorization, apikey

Headers

Authorizationstring required
apikeystring required

Request body

filtersstring required

see table above with all filters (json)

sortstring[] required

sorting order of the response (json array)

page_sizeinteger required

max number of records to return in each page

pagination_token string required

The token should be copied from previous response to continue based on the pagination

Response

recIdstring

Recommendation Id

createdAtstring

Recommendation creation date

createdAtDateTimestring

Recommendation creation date and time

calculatedAtDateTimestring

Recommendation calculation date and time

lastProcessingDatestring

The last date information for this recommendation was received

annualSavingsinteger

Calculated annual savings

monthlySavingsinteger

Monthly savings

annualCurrentCostinteger

Annual current cost

monthlyCurrentCostinteger

Monthly current cost

ageinteger

Recommendation age since creation

cloudProviderstring

AWS, Azure, GCP

typdIdstring

Recommendation type Id in Umbrella Cost

typeNamestring

Recommendation type Name in Umbrella Cost

linkedAccountIdstring

Linked Account Id

linkedAccountNamestring

Linked Account Name

resourceIdstring

Resource included in the recommendation

instanceTypestring

Resource type / family type

regionstring

Resource related region

servicestring

Resource related service

categorystring

Umbrella cost recommendation categories (see table above)

recommendedActionstring

The recommended action.

customTagsstring

custom tags

enrichmentTagsstring

enrichment tags

starredboolean

Is the recommendation starred in the Umbrella Cost App. Values: true / false

commentsstring

Recommendation comments in the Umbrella Cost App.

labelsstring

Recommendation labels added in the Umbrella Cost App.

openboolean

Is the recommendation open. Values: true / false

viewedboolean

Was the recommendation viewed by a user in the Umbrella Cost App. Values: true / false

userStatusstring
  • status: done/excluded/null
  • reason: exclusion reason/null
  • until: exclusion until date/null
  • period: null (deprecated)
recDatastring

Recommendation detailed information. Details may differ according to the recommendation type and resource type. The recommendation data will provide

  • Data regarding current use
  • Data regarding suggested use
  • Recommendation alternatives if they exist

Changes

No recorded changes to this operation across all 1 revision of this API.