Sign in

v1

latestOpenAPI 3.0.12026-07-26152262362.2 KB
Commitment Manager

Retrieve a commitment

Returns a commitment by the specified Id.

get/analytics/v1/commitment-manager/{id}

Path parameters

idstring required

Commitment ID

Response

OK - Commitment returned.

idstring

The unique identifier of the commitment.

namestring

The name of the commitment.

startDatestring date-time

The start date of the commitment.

endDatestring date-time

The end date of the commitment.

currencystring

The currency of the commitment (e.g., USD).

cloudProvider'google-cloud' | 'amazon-web-services' | 'microsoft-azure'

The cloud provider associated with the commitment.

totalCommitmentValuenumber double

The total value of the commitment across all periods.

totalCurrentAttainmentnumber double

The total current spend attainment across all periods.

totalMarketplaceSpendnumber double

The total marketplace spend across all periods.

totalForecastValuenumber double

The total projected spend at the end of the commitment, summed across all periods. 0 when insufficient history is available to compute a forecast.

createTimeinteger

The creation time in milliseconds since epoch.

updateTimeinteger

The last update time in milliseconds since epoch.

Example response

{
  "startDate": "2024-03-10T23:00:00Z",
  "endDate": "2024-03-10T23:00:00Z",
  "currency": "USD",
  "periods": [
    {
      "startDate": "2024-03-10T23:00:00Z",
      "endDate": "2024-03-10T23:00:00Z"
    }
  ]
}