API ReferenceProviders

Get provider-specific recommendations breakdown

GET
/api/v1/providers/{provider_id}/recommendations

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

provider_id*string

Query Parameters

start?|

Start date filter (ISO 8601 format: YYYY-MM-DD)

end?|

End date filter (ISO 8601 format: YYYY-MM-DD)

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, account, tag, monthly_savings, savings_percentage, status)

Default"status"
sort_order?string

Sort order

Default"asc"
Value in"asc" | "desc"
service?array<>|

Filter by service(s) - can be repeated for multiple values

environment?array<>|

Filter by environment(s) - can be repeated for multiple values

account?array<>|

Filter by account(s) - can be repeated for multiple values

tag?array<>|

Filter by tag(s) - can be repeated for multiple values

display_status?array<>|

Filter by display status(es): available, pending, processing, optimized, rejected, unavailable

search?|

Search across recommendation fields (case-insensitive)

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/providers/string/recommendations"
{
  "success": true,
  "timestamp": "2019-08-24T14:15:22Z",
  "data": {
    "total_savings": 0,
    "items": [
      {
        "recommendation_id": "string",
        "service": "string",
        "environment": "string",
        "account": "string",
        "tag": "string",
        "monthly_savings": 0,
        "savings_percentage": 0,
        "status": "pending",
        "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",
        "linked_to": {
          "recommendation_ids": [
            "string"
          ],
          "order": "first"
        }
      }
    ],
    "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"
}