Reference

Get provider potential savings breakdown

Returns paginated potential savings breakdown for a specific provider

GET
/api/v1/providers/{provider_id}/potential-savings/breakdown

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

provider_id*Provider Id

Query Parameters

page?Page

Page number (1-indexed)

page_size?Page Size

Items per page (max 200)

sort_by?Sort By

Field to sort by

sort_order?Sort Order

Sort order

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/providers/string/potential-savings/breakdown"
{
  "success": true,
  "timestamp": "2019-08-24T14:15:22Z",
  "data": {
    "total_savings": 0,
    "total_savings_count": 0,
    "items": [
      {
        "recommendation_id": "string",
        "service": "string",
        "environment": "string",
        "account": "string",
        "tag": "string",
        "monthly_savings": 0,
        "savings_percentage": 0,
        "status": "pending",
        "display_status": "available",
        "actions": {
          "description": "string",
          "overview": "string",
          "implementation_process": "string",
          "execution_method": "string",
          "key_takeaway": "string",
          "operational_impact": "string"
        },
        "terms_accepted_at": "string",
        "saving_accepted_by": "string",
        "saving_acceptance": "string",
        "implementation_method": "string",
        "implementation_status": "in_progress",
        "implementation_tags": [
          "string"
        ],
        "created_at": "string",
        "updated_at": "string",
        "group_id": "string",
        "group_name": "string",
        "linked_to": {
          "recommendation_ids": [
            "string"
          ],
          "order": "first"
        },
        "execution_request_status": "string",
        "execution_request_by": "string",
        "execution_request_by_name": "string",
        "execution_request_at": "string",
        "virtual_tags": {
          "property1": "string",
          "property2": "string"
        },
        "risk_assessment": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "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"
}
{
  "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