Reference

Get aggregate recommendations overview

Returns recommendations overview metrics across all providers (for dashboard)

GET
/api/v1/recommendations/overview

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/recommendations/overview"
{
  "success": true,
  "timestamp": "2019-08-24T14:15:22Z",
  "data": {
    "total_spend": 0,
    "display_savings": {
      "property1": 0,
      "property2": 0
    },
    "display_counts": {
      "property1": 0,
      "property2": 0
    },
    "available_savings": 0,
    "pending_savings": 0,
    "optimized_savings": 0,
    "rejected_savings": 0,
    "unavailable_savings": 0,
    "processing_savings": 0,
    "available_count": 0,
    "pending_count": 0,
    "processing_count": 0,
    "optimized_count": 0,
    "rejected_count": 0,
    "unavailable_count": 0,
    "total_count": 0,
    "saved_itd": 0,
    "awaiting_approval_count": 0,
    "awaiting_approval_savings": 0,
    "potential_savings": 0,
    "evaluation_available_savings": 0,
    "saved_itd_delta_pct": 0,
    "total_pipeline_delta_pct": 0,
    "saved_itd_history": [
      0
    ],
    "top_recommendation": {
      "id": "string",
      "service": "string",
      "service_label": "string",
      "account_name": "string",
      "savings_value": 0
    },
    "top_recommendations": [
      {
        "id": "string",
        "service": "string",
        "service_label": "string",
        "account_name": "string",
        "savings_value": 0
      }
    ]
  }
}
{
  "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"
}
{
  "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"
}
Ask the FinOps Agent about your cloud spend