API ReferenceRecommendations

Get recommendations breakdown with pagination

GET
/api/v1/recommendations

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

page?integer

Page number (1-indexed)

Default1
Range1 <= value
page_size?integer

Items per page (max 200)

Default20
Range1 <= value <= 200
sort_by?string

Field to sort by (recommendation_id, service, environment, monthly_savings, annual_savings, savings_percentage, analysis_period, created_at)

Default"monthly_savings"
sort_order?string

Sort order

Default"desc"
Value in"asc" | "desc"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://loading/api/v1/recommendations"
{
  "success": true,
  "timestamp": "2019-08-24T14:15:22Z",
  "data": {
    "items": [
      {
        "recommendation_id": "string",
        "service": "string",
        "environment": "string",
        "analysis_period": "string",
        "monthly_savings": 0,
        "annual_savings": 0,
        "current_spending": 0,
        "savings_percentage": 0,
        "actions": {
          "description": "string",
          "overview": "string",
          "implementation_process": "string",
          "execution_method": "string",
          "key_takeaway": "string",
          "operational_impact": "string"
        }
      }
    ],
    "pagination": {
      "total_items": 0,
      "total_pages": 0,
      "current_page": 0,
      "page_size": 0,
      "has_next": true,
      "has_previous": true
    }
  }
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "property1": null,
  "property2": null
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  },
  "timestamp": "2019-08-24T14:15:22Z"
}