> ## 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 node pool metrics

> Returns one node pool's cost, node count and spot and on-demand cost split over the period, one point per UTC hour, day or month clipped to the period. node_count is the pool's average nodes in the bucket; cost_usd is the pool's cost in the bucket, and spot_cost_usd and on_demand_cost_usd split it by the bucket's spot and on-demand node-hours. Costs are null when the pool's nodes could not be priced in the bucket. Points are only returned for buckets with recorded data. from and to are RFC 3339 and truncated to the hour, to is exclusive; the default is the last 30 days ending at the last closed hour; a period over 400 days is rejected, and hour granularity is limited to 31 days.



## OpenAPI

````yaml /api-reference/costgraph/openapi.json get /api/v1/tenant/clusters/{cluster_id}/node-pools/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: context-graph
    x-group: Context graph
  - name: cost
    x-group: Cost
  - name: gpus
    x-group: GPUs
  - name: graphai
    x-group: Graph AI
  - name: integrations
    x-group: Integrations
  - name: invitations
    x-group: Invitations
  - name: kubernetes-clusters
    x-group: Kubernetes clusters
  - name: marketplace
    x-group: Marketplace
  - name: network
    x-group: Network
  - 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: sandboxes
    x-group: Sandboxes
  - name: settings
    x-group: Settings
  - name: sso
    x-group: Single sign-on
  - name: tenants
    x-group: Tenants
  - name: ticketing
    x-group: Ticketing
  - 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}/node-pools/metrics:
    get:
      tags:
        - kubernetes-clusters
      summary: Get kubernetes cluster node pool metrics
      description: >-
        Returns one node pool's cost, node count and spot and on-demand cost
        split over the period, one point per UTC hour, day or month clipped to
        the period. node_count is the pool's average nodes in the bucket;
        cost_usd is the pool's cost in the bucket, and spot_cost_usd and
        on_demand_cost_usd split it by the bucket's spot and on-demand
        node-hours. Costs are null when the pool's nodes could not be priced in
        the bucket. Points are only returned for buckets with recorded data.
        from and to are RFC 3339 and truncated to the hour, to is exclusive; the
        default is the last 30 days ending at the last closed hour; a period
        over 400 days is rejected, and hour granularity is limited to 31 days.
      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: Autoscaler that runs the pool
          name: pool_autoscaler
          in: query
          required: true
          schema:
            type: string
        - description: Node pool name
          name: pool
          in: query
          required: true
          schema:
            type: string
        - description: Period start (RFC 3339, inclusive)
          name: from
          in: query
          schema:
            type: string
        - description: Period end (RFC 3339, exclusive)
          name: to
          in: query
          schema:
            type: string
        - description: 'Point size: hour, day (default) or month'
          name: granularity
          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/operator.NodePoolTrendSeries'
        '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
    operator.NodePoolTrendSeries:
      type: object
      required:
        - from
        - granularity
        - points
        - to
      properties:
        from:
          type: string
        granularity:
          type: string
        points:
          type: array
          items:
            $ref: '#/components/schemas/operator.NodePoolTrendPoint'
        to:
          type: string
    responses.ErrorResponse:
      type: object
      required:
        - message
        - status
      properties:
        message:
          type: string
          example: some message
        status:
          type: string
          example: error
    operator.NodePoolTrendPoint:
      type: object
      required:
        - bucket_start
        - node_count
      properties:
        bucket_start:
          type: string
        cost_usd:
          type: number
          x-semantic: costAmount
          nullable: true
        node_count:
          type: number
        on_demand_cost_usd:
          type: number
          x-semantic: costAmount
          nullable: true
        spot_cost_usd:
          type: number
          x-semantic: costAmount
          nullable: true
  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.