v1

latestOpenAPI 3.0.02026-08-0645003.8 MB

Insights Service

Get Organization Savings

Get the savings of the organization between the input time range.

get/insights/savings

Query parameters

fromDatestring

Date can be either in ISO-8601 date format (yyyy-mm-dd) or in Unix Timestamp format (e.g. 1494751821472). *Minimum from date can be one year ago.

toDatestring

Date can be either in ISO-8601 date format (yyyy-mm-dd) or in Unix Timestamp format (e.g. 1494751821472). *Data is shown until the past day (Does not include today's costs)

includeVmIdsboolean

If set to true, the response will include the VM IDs for each savings entry. Default is false.

Response

organization savings Response

Example response

{
  "request": {
    "id": "67582d0c-108b-4ef7-9fdc-d39678a30844",
    "url": "/insights/savings",
    "method": "GET",
    "timestamp": "2022-01-10T00:00:00.000Z"
  },
  "response": {
    "status": {
      "code": 200,
      "message": "OK"
    },
    "kind": "savings:extended:resource",
    "items": [
      {
        "resources": [
          {
            "accountId": "act-12345678",
            "accountName": "production account",
            "resourceId": "o-7dd944535",
            "resourceName": "Ocean Kubernetes cluster name",
            "productType": "AWS_KUBERNETES_OCEAN",
            "runningHours": 107.3,
            "actualCosts": 107.3,
            "potentialCosts": 378.41,
            "amountSaved": 306.77
          }
        ],
        "summary": {
          "runningHours": 117.3,
          "actualCosts": 207.3,
          "potentialCosts": 11378.41,
          "amountSaved": 1306.77
        }
      }
    ],
    "count": 1
  }
}