Metrics (Beta)

Organization-level metrics and overview

Get organization overview

get

Returns a high-level overview of the organization's commitment performance including savings, coverage, utilization, missed savings opportunities, automation status, and prioritized recommended actions.

Path parameters

org_idstring · uuidRequired

Query parameters

providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Example: awsPossible values:

Responses

200

OK

application/json

monthly_net_savingsnumberOptional

Current monthly net savings rate from active commitments

expiring_monthly_savingsnumberOptional

Monthly savings at risk from commitments expiring in the next 30 days

coveragenumber · nullableOptional

Overall spend-based commitment coverage ratio (0-1): share of reservable on-demand-equivalent spend covered, not the share of hours or usage units.

utilizationnumber · nullableOptional

Overall commitment utilization ratio (0-1)

purchase_missed_savingsnumberOptional

Monthly savings available by applying the recommended commitment plan. 0 if a plan has already been applied.

buyback_missed_savingsnumberOptional

Monthly savings available from pending buyback opportunities

purchase_automation_enabledbooleanOptional

Whether automatic commitment purchasing is enabled

buyback_automation_enabledbooleanOptional

Whether automatic buyback/sellback is enabled

has_actioned_planbooleanOptional

Whether the organization has ever applied a commitment plan

data_available_sincestring · date · nullableOptional

Earliest date cost data is available for this provider (null if no data)

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/beta/v1/org/{org_id}/metrics/overview

HTTPcURLJavaScriptPython

GET /beta/v1/org/{org_id}/metrics/overview?provider=aws HTTP/1.1
Accept: */*

{
  "monthly_net_savings": 1,
  "expiring_monthly_savings": 1,
  "coverage": 1,
  "utilization": 1,
  "purchase_missed_savings": 1,
  "buyback_missed_savings": 1,
  "purchase_automation_enabled": true,
  "buyback_automation_enabled": true,
  "has_actioned_plan": true,
  "data_available_since": "2026-08-07",
  "recommended_actions": [
    {
      "action": "text",
      "description": "text",
      "monthly_impact": 1,
      "priority": "text"
    }
  ]
}

Get daily coverage

get

Returns spend-based commitment coverage over the requested date range, weighted by each day's reservable on-demand-equivalent spend, plus per-day values for trend analysis. Coverage is not weighted by hours or usage units.

Path parameters

org_idstring · uuidRequired

Query parameters

providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Example: awsPossible values:

segment_idstring · uuid · nullableOptional

Optional segment ID to scope results. Defaults to the provider resources segment if not specified.

Default: null

start_datestring · dateRequired

Start date (YYYY-MM-DD)

end_datestring · dateRequired

End date (YYYY-MM-DD, exclusive)

group_bystring · enum · nullableOptional

Dimension to group daily metrics by: 'service', 'account', or 'region'. If omitted, groups is null and the top-level response is the overall total.

Default: nullPossible values:

Responses

200

OK

application/json

period_startstringOptional

Effective start date of the returned data (YYYY-MM-DD). May be later than the requested start_date if the range was clamped to available data.

period_endstringOptional

Effective end date of the returned data, exclusive (YYYY-MM-DD). May be earlier than the requested end_date if the range was clamped to available data (e.g. cloud-provider cost-data lag).

coveragenumber · nullableOptional

Spend-based commitment coverage across the effective date range (0-1): the share of reservable on-demand-equivalent spend covered by commitments, weighted by each day's spend rather than hours or usage units.

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/beta/v1/org/{org_id}/metrics/daily-coverage

HTTPcURLJavaScriptPython

GET /beta/v1/org/{org_id}/metrics/daily-coverage?provider=aws&start_date=2026-08-07&end_date=2026-08-07 HTTP/1.1
Accept: */*

{
  "period_start": "text",
  "period_end": "text",
  "coverage": 1,
  "daily": [
    {
      "date": "2026-08-07",
      "coverage": 1
    }
  ],
  "groups": [
    {
      "name": "text",
      "coverage": 1,
      "daily": [
        {
          "date": "2026-08-07",
          "coverage": 1
        }
      ]
    }
  ]
}

Get daily savings

get

Returns daily commitment savings with cost and savings grouped, plus period-level totals.

Path parameters

org_idstring · uuidRequired

Query parameters

providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Example: awsPossible values:

segment_idstring · uuid · nullableOptional

Optional segment ID to scope results. Defaults to the provider resources segment if not specified.

Default: null

start_datestring · dateRequired

Start date (YYYY-MM-DD)

end_datestring · dateRequired

End date (YYYY-MM-DD, exclusive)

group_bystring · enum · nullableOptional

Dimension to group daily metrics by: 'service', 'account', or 'region'. If omitted, groups is null and the top-level response is the overall total.

Default: nullPossible values:

Responses

200

OK

application/json

period_startstringOptional

Effective start date of the returned data (YYYY-MM-DD). May be later than the requested start_date if the range was clamped to available data.

period_endstringOptional

Effective end date of the returned data, exclusive (YYYY-MM-DD). May be earlier than the requested end_date if the range was clamped to available data (e.g. cloud-provider cost-data lag).

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/beta/v1/org/{org_id}/metrics/daily-savings

HTTPcURLJavaScriptPython

GET /beta/v1/org/{org_id}/metrics/daily-savings?provider=aws&start_date=2026-08-07&end_date=2026-08-07 HTTP/1.1
Accept: */*

{
  "period_start": "text",
  "period_end": "text",
  "commitment_financials_period_total": {
    "commitment_cost": {
      "total": 1,
      "breakdown": {
        "cloud_provider_cost": {
          "total": 1,
          "breakdown": {
            "recurring": 1,
            "amortized_upfront": 1
          }
        },
        "archera_premium": 1
      }
    },
    "commitment_savings": {
      "net": 1,
      "gross": 1
    },
    "covered_ondemand_cost": 1
  },
  "daily": [
    {
      "date": "2026-08-07",
      "commitment_financials_daily_total": {
        "commitment_cost": {
          "total": 1,
          "breakdown": {
            "cloud_provider_cost": {
              "total": 1,
              "breakdown": {
                "recurring": 1,
                "amortized_upfront": 1
              }
            },
            "archera_premium": 1
          }
        },
        "commitment_savings": {
          "net": 1,
          "gross": 1
        },
        "covered_ondemand_cost": 1
      }
    }
  ],
  "groups": [
    {
      "name": "text",
      "commitment_financials_period_total": {
        "commitment_cost": {
          "total": 1,
          "breakdown": {
            "cloud_provider_cost": {
              "total": 1,
              "breakdown": {
                "recurring": 1,
                "amortized_upfront": 1
              }
            },
            "archera_premium": 1
          }
        },
        "commitment_savings": {
          "net": 1,
          "gross": 1
        },
        "covered_ondemand_cost": 1
      },
      "daily": [
        {
          "date": "2026-08-07",
          "commitment_financials_daily_total": {
            "commitment_cost": {
              "total": 1,
              "breakdown": {
                "cloud_provider_cost": {
                  "total": 1,
                  "breakdown": {
                    "recurring": 1,
                    "amortized_upfront": 1
                  }
                },
                "archera_premium": 1
              }
            },
            "commitment_savings": {
              "net": 1,
              "gross": 1
            },
            "covered_ondemand_cost": 1
          }
        }
      ]
    }
  ]
}

Get daily reservable cost breakdown

get

Returns daily cost for reservable services over the date range, split by pricing type (uncovered, commitment-covered). The commitment bucket is further split into cloud_provider_cost + archera_premium. Includes period-level totals and total savings vs on-demand baseline.

Path parameters

org_idstring · uuidRequired

Query parameters

providerstring · enumRequired

Cloud provider (aws, azure, gcp)

Example: awsPossible values:

segment_idstring · uuid · nullableOptional

Optional segment ID to scope results. Defaults to the provider resources segment if not specified.

Default: null

start_datestring · dateRequired

Start date (YYYY-MM-DD)

end_datestring · dateRequired

End date (YYYY-MM-DD, exclusive)

group_bystring · enum · nullableOptional

Dimension to group daily metrics by: 'service', 'account', or 'region'. If omitted, groups is null and the top-level response is the overall total.

Default: nullPossible values:

Responses

200

OK

application/json

period_startstringOptional

Effective start date of the returned data (YYYY-MM-DD). May be later than the requested start_date if the range was clamped to available data.

period_endstringOptional

Effective end date of the returned data, exclusive (YYYY-MM-DD). May be earlier than the requested end_date if the range was clamped to available data (e.g. cloud-provider cost-data lag).

total_costnumberOptional

Total paid for reservable services over the effective date range.

if_all_ondemand_costnumberOptional

On-demand baseline: what the range would cost at on-demand prices.

total_savingsnumberOptional

Total savings across all discount types (if_all_ondemand_cost - total_cost).

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

get/beta/v1/org/{org_id}/metrics/daily-reservable-cost

HTTPcURLJavaScriptPython

GET /beta/v1/org/{org_id}/metrics/daily-reservable-cost?provider=aws&start_date=2026-08-07&end_date=2026-08-07 HTTP/1.1
Accept: */*

{
  "period_start": "text",
  "period_end": "text",
  "total_cost": 1,
  "if_all_ondemand_cost": 1,
  "total_savings": 1,
  "by_pricing_type": {
    "ondemand_cost": 1,
    "commitment_cost": {
      "total": 1,
      "breakdown": {
        "cloud_provider_cost": {
          "total": 1,
          "breakdown": {
            "recurring": 1,
            "amortized_upfront": 1
          }
        },
        "archera_premium": 1
      }
    }
  },
  "daily": [
    {
      "date": "2026-08-07",
      "total_cost": 1,
      "if_all_ondemand_cost": 1,
      "by_pricing_type": {
        "ondemand_cost": 1,
        "commitment_cost": {
          "total": 1,
          "breakdown": {
            "cloud_provider_cost": {
              "total": 1,
              "breakdown": {
                "recurring": 1,
                "amortized_upfront": 1
              }
            },
            "archera_premium": 1
          }
        }
      }
    }
  ],
  "groups": [
    {
      "name": "text",
      "total_cost": 1,
      "if_all_ondemand_cost": 1,
      "total_savings": 1,
      "by_pricing_type": {
        "ondemand_cost": 1,
        "commitment_cost": {
          "total": 1,
          "breakdown": {
            "cloud_provider_cost": {
              "total": 1,
              "breakdown": {
                "recurring": 1,
                "amortized_upfront": 1
              }
            },
            "archera_premium": 1
          }
        }
      },
      "daily": [
        {
          "date": "2026-08-07",
          "total_cost": 1,
          "if_all_ondemand_cost": 1,
          "by_pricing_type": {
            "ondemand_cost": 1,
            "commitment_cost": {
              "total": 1,
              "breakdown": {
                "cloud_provider_cost": {
                  "total": 1,
                  "breakdown": {
                    "recurring": 1,
                    "amortized_upfront": 1
                  }
                },
                "archera_premium": 1
              }
            }
          }
        }
      ]
    }
  ]
}