Reference
Get spending summary
Returns spending summary: overall costs, forecast, savings, and provider breakdown
Authorization
BearerAuth AuthorizationBearer <token>
In: header
Query Parameters
providerId?|
Scope the summary to one provider. A provider the tenant has not enabled returns an empty summary.
credits?Credits
Cost basis for Google Cloud: after credits (default) or before them. AWS stays on its invoiced basis.
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/costs/summary"{
"success": true,
"timestamp": "2019-08-24T14:15:22Z",
"data": {
"overall_monthly_costs": 0,
"overall_monthly_costs_percentage": 0,
"forecasted_monthly_costs": 0,
"forecasted_monthly_costs_percentage": 0,
"last_month_spend": 0,
"last_month_spend_percentage": 0,
"savings_recommendations": 0,
"savings_recommendations_percentage": 0,
"total_savings": 0,
"providers": [
{
"provider_id": "string",
"provider_name": "string",
"monthly_spending": 0,
"monthly_spending_percentage": 0,
"monthly_spending_change": 0,
"previous_month_spending": 0,
"potential_savings": 0,
"potential_savings_percentage": 0
}
],
"spend_split": {
"commit_monthly": 0,
"on_demand_monthly": 0,
"spot_monthly": 0
},
"credits": "before"
}
}{
"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"
}