Reference
Get commitments overview
ESR strip and aggregate RI/SP metrics for the requested provider (AWS real, GCP/Azure return zeros).
Authorization
BearerAuth In: header
Query 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/overview"{
"success": true,
"timestamp": "2019-08-24T14:15:22Z",
"data": {
"global_esr": 0,
"benchmark_esr": 0,
"total_committed_monthly": 0,
"total_cloud_spend_monthly": 0,
"coverage_pct": 0,
"coverage_delta_pp": 0,
"estimated_waste_monthly": 0,
"waste_commitment_count": 0,
"potential_additional_savings_monthly": 0,
"commitment_count": 0,
"expiring_count": 0,
"accounts": [
{
"account_id": "string",
"account_name": "string",
"monthly_spend": 0,
"esr_pct": 0,
"monthly_saved": 0,
"could_save_additional": 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"
}One row per commitment GET
Every reservation or plan the tenant holds, one row each, with the state the cloud reports rather than one derived from the end date. A plan that starts next month is queued and one whose payment failed is neither running nor expired, and no date says either. Attributes only some services carry arrive as null rather than zero.
Commitment portfolio ledger GET
One row per commitment across every connected account, resolving the account that holds it against the accounts that consume it, with the expiry instant, the utilization trend, and what a renewal protects kept separate from what right-sizing would save.