Reference
Get commitment detail
Authorization
BearerAuth In: header
Path Parameters
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/commitments/detail/string"{
"success": true,
"timestamp": "2019-08-24T14:15:22Z",
"data": {
"id": "string",
"provider": "string",
"service": "string",
"service_label": "string",
"account_id": "string",
"account_name": "string",
"region": "string",
"kind": "reserved_instance",
"start_date": "string",
"end_date": "string",
"term_months": 0,
"payment_option": "all_upfront",
"hourly_commitment_usd": 0,
"monthly_commitment_usd": 0,
"status": "active",
"current_utilization_pct": 0,
"current_coverage_pct": 0,
"is_commitable": true,
"figures_source": "cur",
"end_at": "string",
"holder_account_id": "string",
"unit_count": 1,
"fee_monthly_list": 0,
"fee_monthly_net": 0,
"utilization_slope_pp_30d": 0,
"protects_monthly": 0,
"rightsizing_monthly": 0,
"exchangeable": true,
"cancellable": true,
"renewal_recommendation_id": "string",
"utilization_history": [
{
"date": "string",
"utilization_pct": 0,
"purchased_hours": 0,
"used_hours": 0,
"unused_cost": 0
}
],
"coverage_history": [
{
"date": "string",
"coverage_pct": 0
}
],
"consumers": [
{
"account_id": "string",
"account_name": "string",
"covered_spend_monthly": 0,
"covered_hours": 0
}
],
"history": [
{
"id": "string",
"type": "purchased",
"timestamp": "string",
"actor": {
"email": "string",
"account_id": "string"
},
"details": {
"property1": "string",
"property2": "string"
}
}
],
"recommendations": [
{
"id": "string",
"kind": "buy_reserved_instance",
"monthly_savings": 0,
"confidence": "high",
"summary": "string"
}
]
}
}{
"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"
}Get coverage rows GET
Deprecated, use /coverage-rates. This reads one row per commitment held, so usage no commitment covers has no row and cannot appear, which is the larger half of coverage. on_demand_cost_monthly, saved_vs_od_monthly and filtered_savings_monthly are not measured here and are sent as zero, and filtered_coverage_pct averages percentages across commitments rather than weighting them by spend.
Effective savings rate, globally and per account GET
What the same usage would have cost at public on-demand rates against what it actually cost, for the organization and for each account that consumed the benefit. The rate is split into the part a negotiated agreement earns and the part commitments earn, because the public on-demand price sits above both and an account owning no commitment at all would otherwise report a healthy rate. esr_pct is the rate after idle commitment, and is null until the month is complete. months adds that many calendar months ending at period, for the organization, each payer and each account.