Sign in

v1

latestOpenAPI 3.0.12026-07-26152262362.2 KB
Commitment Manager

List commitments

Returns a list of commitments for the customer. Commitments are listed in reverse chronological order by default.

get/analytics/v1/commitment-manager

Query parameters

sortBy'name' | 'startDate' | 'endDate' | 'provider' | 'createTime' | 'updateTime'

A field by which the results will be sorted.

sortOrder'asc' | 'desc'

Sort order can be ascending or descending.

maxResultsstring

The maximum number of results to return in a single page. Use the page tokens to iterate through the entire collection.

pageTokenstring

Page token, returned by a previous call, to request the next page of results

filterstring

An expression for filtering the results. The syntax is key:[<value>]. Multiple filters can be connected using a pipe |. See Filters. Available filter keys: name, provider

Response

OK - The request succeeded.

pageTokenstring

Page token. It is used to request a specific page of the list results.

rowCountinteger

The number of returned records.

Example response

{
  "pageToken": "bDl0QkEwVFZxUEwxaUJRaHhTcXM",
  "rowCount": 1,
  "commitments": [
    {
      "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"
        }
      ]
    }
  ]
}