> ## Documentation Index
> Fetch the complete documentation index at: https://docs.costgraph.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get kubernetes cluster metrics

> Returns per-resource-group usage, request, waste, and recommended time-series for a specific kubernetes cluster, sourced from hourly rollup tables



## OpenAPI

````yaml /api-reference/costgraph/openapi.json get /api/v1/tenant/clusters/{cluster_id}/metrics
openapi: 3.0.0
info:
  description: Read and manage your CostGraph organization, spend, alerts, and settings.
  title: CostGraph API
  contact: {}
  version: '1.0'
servers:
  - url: https://api.costgraph.ai
security: []
tags:
  - name: ai
    x-group: AI
  - name: ai-serving
    x-group: AI serving
  - name: anomalies
    x-group: Anomalies
  - name: auth
    x-group: Auth
  - name: billing
    x-group: Billing
  - name: billing-export
    x-group: Billing export
  - name: budgets
    x-group: Budgets
  - name: ci
    x-group: CI
  - name: compute-recommendations
    x-group: Compute recommendations
  - name: config
    x-group: Config
  - name: cost
    x-group: Cost
  - name: gpus
    x-group: GPUs
  - name: graphai
    x-group: Graph AI
  - name: infracost
    x-group: Infracost
  - name: integrations
    x-group: Integrations
  - name: invitations
    x-group: Invitations
  - name: kubernetes-clusters
    x-group: Kubernetes clusters
  - name: marketplace
    x-group: Marketplace
  - name: network-requests
    x-group: Network requests
  - name: notifications
    x-group: Notifications
  - name: oauth
    x-group: OAuth
  - name: oauth-clients
    x-group: OAuth clients
  - name: opencost
    x-group: OpenCost
  - name: organization
    x-group: Audit log
  - name: organizations
    x-group: Organizations
  - name: placement-alternatives
    x-group: Placement alternatives
  - name: reports
    x-group: Reports
  - name: service-map
    x-group: Service map
  - name: settings
    x-group: Settings
  - name: sso
    x-group: Single sign-on
  - name: tenants
    x-group: Tenants
  - name: user
    x-group: Users
  - name: virtual-machines
    x-group: Virtual machines
  - name: virtual-tags
    x-group: Virtual tags
  - name: workflows
    x-group: Workflows
paths:
  /api/v1/tenant/clusters/{cluster_id}/metrics:
    get:
      tags:
        - kubernetes-clusters
      summary: Get kubernetes cluster metrics
      description: >-
        Returns per-resource-group usage, request, waste, and recommended
        time-series for a specific kubernetes cluster, sourced from hourly
        rollup tables
      parameters:
        - description: Tenant ID
          name: X-CostGraph-Tenant-ID
          in: header
          required: true
          schema:
            type: string
        - description: Kubernetes cluster ID
          name: cluster_id
          in: path
          required: true
          schema:
            type: string
        - description: Time window (e.g. 24h, 7d, 30d). Default 7d
          name: range
          in: query
          schema:
            type: string
        - description: Resolution step (minimum 1h, data is hourly)
          name: step
          in: query
          schema:
            type: string
        - description: >-
            Resource groups to fetch (comma-separated):
            all,cpu,memory,disk_iops,disk_throughput,disk_capacity. Default all
          name: groups
          in: query
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/responses.SuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/k8scluster.Metrics'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    responses.SuccessResponse:
      type: object
      required:
        - message
        - status
      properties:
        data: {}
        message:
          type: string
          example: some message
        status:
          type: string
          example: success
    k8scluster.Metrics:
      type: object
      required:
        - currency
        - end
        - resources
        - start
        - step_seconds
      properties:
        currency:
          type: string
          x-semantic: currencyCode
        end:
          type: string
        resources:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/k8scluster.ResourceSeries'
        start:
          type: string
        step_seconds:
          type: integer
    responses.ErrorResponse:
      type: object
      required:
        - message
        - status
      properties:
        message:
          type: string
          example: some message
        status:
          type: string
          example: error
    k8scluster.ResourceSeries:
      type: object
      required:
        - allocated
        - recommended
        - request
        - unit
        - usage
        - waste
      properties:
        allocated:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        recommended:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        request:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        savings:
          description: >-
            Savings is the net saving from applying this group's recommendations

            (current cost minus recommended cost) in the response Currency, a
            current

            report snapshot rather than a per-window integral.
          type: number
          x-semantic: costAmount
          nullable: true
        unit:
          type: string
        usage:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
        waste:
          type: array
          items:
            $ref: '#/components/schemas/metrics.MetricPoint'
    metrics.MetricPoint:
      type: object
      required:
        - t
        - v
      properties:
        t:
          type: integer
        v:
          type: number
  securitySchemes:
    BearerAuth:
      description: Enter "Bearer {token}"
      type: apiKey
      name: Authorization
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.