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

# Get costs for Kubernetes efficiency report

> Return costs for a KubernetesEfficiencyReport.



## OpenAPI

````yaml https://api.vantage.sh/v2/oas_v3.json get /kubernetes_efficiency_reports/{kubernetes_efficiency_report_token}/costs
openapi: 3.0.1
info:
  title: Vantage
  description: Vantage API
  termsOfService: https://www.vantage.sh/terms-of-use
  contact:
    name: Vantage Support
    url: https://www.vantage.sh
    email: support@vantage.sh
  version: 2.0.0
servers:
  - url: https://api.vantage.sh/v2
security:
  - oauth2:
      - read
tags:
  - name: AccessGrants
    description: Operations about AccessGrants
  - name: AccessPolicies
    description: Operations about AccessPolicies
  - name: Annotations
    description: Operations about Annotations
  - name: AnomalyAlerts
    description: Operations about AnomalyAlerts
  - name: AnomalyNotifications
    description: Operations about AnomalyNotifications
  - name: AuditLogs
    description: Operations about AuditLogs
  - name: BillingProfiles
    description: Operations about BillingProfiles
  - name: BillingRules
    description: Operations about BillingRules
  - name: BudgetAlerts
    description: Operations about BudgetAlerts
  - name: Budgets
    description: Operations about Budgets
  - name: BusinessMetrics
    description: Operations about BusinessMetrics
  - name: Canvases
    description: Operations about Canvases
  - name: CostAlertEvents
    description: Operations about CostAlertEvents
  - name: CostAlerts
    description: Operations about CostAlerts
  - name: CostProvider
    description: Operations about CostProviders
  - name: CostProviderAccounts
    description: Operations about CostProviderAccounts
  - name: Costs
    description: Operations about Costs
  - name: CostService
    description: Operations about CostServices
  - name: Dashboards
    description: Operations about Dashboards
  - name: DataExports
    description: Operations about DataExports
  - name: ExchangeRates
    description: Operations about ExchangeRates
  - name: FinancialCommitmentReports
    description: Operations about FinancialCommitmentReports
  - name: FinancialCommitments
    description: Operations about FinancialCommitments
  - name: Folders
    description: Operations about Folders
  - name: Integrations
    description: Operations about Integrations
  - name: Invoices
    description: Operations about Invoices
  - name: KubernetesEfficiencyReports
    description: Operations about KubernetesEfficiencyReports
  - name: ManagedAccounts
    description: Operations about ManagedAccounts
  - name: Me
    description: Operations about Mes
  - name: NetworkFlowLogs
    description: Operations about NetworkFlowLogs
  - name: NetworkFlowReports
    description: Operations about NetworkFlowReports
  - name: OpenAPISpecification
    description: Operations about OpenAPISpecifications
  - name: Ping
    description: Operations about Pings
  - name: Prices
    description: Operations about Prices
  - name: Recommendations
    description: Operations about Recommendations
  - name: RecommendationViews
    description: Operations about RecommendationViews
  - name: ReportForecasts
    description: Operations about ReportForecasts
  - name: ReportNotifications
    description: Operations about ReportNotifications
  - name: ResourceReports
    description: Operations about ResourceReports
  - name: Resources
    description: Operations about Resources
  - name: SavedFilters
    description: Operations about SavedFilters
  - name: ScenarioModels
    description: Operations about ScenarioModels
  - name: Segments
    description: Operations about Segments
  - name: Tags
    description: Operations about Tags
  - name: Teams
    description: Operations about Teams
  - name: UnitCosts
    description: Operations about UnitCosts
  - name: UserFeedback
    description: Operations about UserFeedbacks
  - name: Users
    description: Operations about Users
  - name: VirtualTags
    description: Operations about VirtualTags
  - name: Workspaces
    description: Operations about Workspaces
paths:
  /kubernetes_efficiency_reports/{kubernetes_efficiency_report_token}/costs:
    get:
      tags:
        - KubernetesEfficiencyReports
      summary: Get costs for Kubernetes efficiency report
      description: Return costs for a KubernetesEfficiencyReport.
      operationId: getKubernetesEfficiencyReportCosts
      parameters:
        - name: kubernetes_efficiency_report_token
          in: path
          required: true
          schema:
            type: string
        - name: start_date
          in: query
          description: First date to query costs from, inclusive. YYYY-MM-DD formatted.
          schema:
            type: string
            format: date
          example: '2026-09-01'
        - name: end_date
          in: query
          description: Last date to query costs through, inclusive. YYYY-MM-DD formatted.
          schema:
            type: string
            format: date
          example: '2026-09-30'
        - name: date_bin
          in: query
          description: >-
            The date bin for the costs. Defaults to the report's configured date
            bucket.
          schema:
            type: string
            enum:
              - day
              - week
              - month
              - quarter
        - name: groupings
          in: query
          description: >-
            Group the cost rows by up to 100 fields. Valid groupings:
            cluster_id, namespace, region, labeled, category, pod,
            label:<label_name>.
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
              oneOf:
                - type: string
                  enum:
                    - cluster_id
                    - namespace
                    - region
                    - labeled
                    - category
                    - pod
                - type: string
                  pattern: >-
                    ^label:(?=[\s\S]*\S)(?![\s\S]*(?:['"`\\;]|--|[\x00-\x1F]))[\s\S]+$
        - name: filter
          in: query
          description: >-
            The VQL filter to apply to the costs. Overrides the report's saved
            filter.
          schema:
            type: string
        - name: order
          in: query
          description: Whether to order cost rows by date ascending or descending.
          schema:
            type: string
            default: desc
            enum:
              - asc
              - desc
        - name: page
          in: query
          description: The page of cost rows to return.
          schema:
            type: integer
            format: int32
            default: 1
        - name: limit
          in: query
          description: The number of cost rows to return. The maximum is 2500.
          schema:
            maximum: 2500
            minimum: 1
            type: integer
            format: int32
            default: 500
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KubernetesEfficiencyReportCosts'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '402':
          description: PaymentRequired
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: UnprocessableEntity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      security:
        - oauth2:
            - read
components:
  schemas:
    KubernetesEfficiencyReportCosts:
      required:
        - costs
        - total_amount
        - total_cost_efficiency
        - total_idle_cost
      type: object
      properties:
        links:
          $ref: '#/components/schemas/Links'
        total_amount:
          $ref: '#/components/schemas/CostPartial'
        total_idle_cost:
          $ref: '#/components/schemas/CostPartial'
        total_cost_efficiency:
          type: string
          description: The cost efficiency ratio for the complete filtered result.
          nullable: false
          example: '0.66666666666666666667'
        costs:
          type: array
          items:
            $ref: '#/components/schemas/KubernetesEfficiencyReportCost'
      description: KubernetesEfficiencyReportCosts model
    Errors:
      required:
        - errors
      type: object
      properties:
        links:
          $ref: '#/components/schemas/Links'
        errors:
          type: array
          nullable: false
          items:
            type: string
      description: Errors model
    Links:
      type: object
      properties:
        self:
          type: string
          description: The URL of the current page of results.
          nullable: true
        first:
          type: string
          description: The URL of the first page of results.
          nullable: true
        next:
          type: string
          description: The URL of the next page of results, if one exists.
          nullable: true
        last:
          type: string
          description: The URL of the last page of results, if one exists.
          nullable: true
        prev:
          type: string
          description: The URL of the previous page of results, if one exists.
          nullable: true
    CostPartial:
      required:
        - amount
        - currency
      type: object
      properties:
        amount:
          type: string
          description: The amount of the cost.
          nullable: false
          example: '4.25'
        currency:
          type: string
          description: The currency of the cost.
          nullable: false
          example: USD
    KubernetesEfficiencyReportCost:
      required:
        - accrued_at
        - amount
        - cost_efficiency
        - currency
        - idle_cost
      type: object
      properties:
        accrued_at:
          type: string
          description: The date bucket for the cost. YYYY-MM-DD formatted.
          nullable: false
          example: '2026-09-01'
        amount:
          type: string
          description: The total cost amount for the row.
          nullable: false
          example: '120'
        idle_cost:
          type: string
          description: The idle cost amount for the row.
          nullable: false
          example: '40'
        cost_efficiency:
          type: string
          description: >-
            The cost efficiency ratio for the row, expressed from 0 to 1 under
            ordinary inputs.
          nullable: false
          example: '0.66666666666666666667'
        currency:
          type: string
          description: The ISO 4217 currency code for the costs.
          nullable: false
          example: USD
        cluster_id:
          type: string
          description: The cluster_id grouping value.
          nullable: true
        namespace:
          type: string
          description: The namespace grouping value.
          nullable: true
        region:
          type: string
          description: The region grouping value.
          nullable: true
        category:
          type: string
          description: The category grouping value.
          nullable: true
        pod:
          type: string
          description: The pod grouping value.
          nullable: true
        labeled:
          type: boolean
          description: Whether the aggregated Kubernetes records contain any labels.
          nullable: false
        labels:
          type: array
          description: The requested Kubernetes label grouping values.
          items:
            $ref: '#/components/schemas/KubernetesEfficiencyReportCostLabel'
    KubernetesEfficiencyReportCostLabel:
      required:
        - key
        - value
      type: object
      properties:
        key:
          type: string
          description: The Kubernetes label key.
          nullable: false
          example: app
        value:
          type: string
          description: The Kubernetes label value. Null when the label key is not present.
          nullable: true
          example: payments
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://console.vantage.sh/account/profile
          scopes:
            read: Grants read access
            write: Grants write access

````