Organization-level metrics and overview

GitBook Assistant

Get organization overview

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

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_id: string · uuid Required

Query parameters

• provider: string · enum Required
  Cloud provider (aws, azure, gcp)
  Example: aws Possible values: aws azure gcp

Responses

200 OK

{
  "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-07-27",
  "recommended_actions": [
    {
      "action": "text",
      "description": "text",
      "monthly_impact": 1,
      "priority": "text"
    }
  ]
}

400 Bad request
401 Unauthorized
403 Forbidden
404 Not found
405 Method not allowed
409 Conflict
422 Unprocessable Content
500 Internal server error
default Default error response

Get daily coverage

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

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_id: string · uuid Required

Query parameters

• provider: string · enum Required
• segment_id: string · uuid · nullable Optional
• start_date: string · date Required
• end_date: string · date Required
• group_by: string · enum · nullable Optional

Responses

200 OK

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

Get daily savings

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

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

Path parameters

• org_id: string · uuid Required

Responses

200 OK

{
  "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-07-27",
      "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-07-27",
          "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/beta/v1/org/{org_id}/metrics/daily-reservable-cost

Returns daily cost for reservable services over the date range, split by pricing type (uncovered, commitment-covered).

Path parameters

• org_id: string · uuid Required

Responses

200 OK

{
  "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-07-27",
      "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-07-27",
          "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
              }
            }
          }
        }
      ]
    }
  ]
}