> ## 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.

# Cost overview

> Total spend for a period with change vs the prior equal window, plus a cost-by-provider breakdown. Defaults to month-to-date.



## OpenAPI

````yaml /api-reference/costgraph/openapi.json get /api/v1/tenant/cost/overview
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/cost/overview:
    get:
      tags:
        - cost
      summary: Cost overview
      description: >-
        Total spend for a period with change vs the prior equal window, plus a
        cost-by-provider breakdown. Defaults to month-to-date.
      parameters:
        - description: Tenant ID
          name: X-CostGraph-Tenant-ID
          in: header
          required: true
          schema:
            type: string
        - description: Cost period; defaults to month_to_date
          name: period
          in: query
          schema:
            type: string
            enum:
              - month_to_date
              - last_7d
              - last_30d
              - calendar_month
              - custom
        - description: >-
            Closed calendar month in YYYY-MM format; required when
            period=calendar_month
          name: month
          in: query
          schema:
            type: string
        - description: Window start in RFC3339 format; required when period=custom
          name: start
          in: query
          schema:
            type: string
        - description: Window end in RFC3339 format; required when period=custom
          name: end
          in: query
          schema:
            type: string
        - description: >-
            ISO 4217 code to express every amount in, converted at each day's
            exchange rate; defaults to the currency most of the selected
            period's spend was billed in, or USD when none dominates
          name: reporting_currency
          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/cost.Overview'
        '400':
          description: Bad Request
          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
    cost.Overview:
      type: object
      required:
        - by_provider
        - currency
        - period
        - period_end
        - period_start
        - previous_cost
        - previous_period_end
        - previous_period_start
        - total_cost
        - total_cost_annual
        - unconverted
      properties:
        by_provider:
          type: array
          items:
            $ref: '#/components/schemas/cost.ProviderSpend'
        clusters_efficiency:
          type: number
          nullable: true
        cost_change_percent:
          type: number
          nullable: true
        currency:
          type: string
        period:
          type: string
        period_end:
          type: string
        period_start:
          type: string
        possible_savings:
          type: number
          nullable: true
        previous_cost:
          type: number
        previous_period_end:
          type: string
        previous_period_start:
          type: string
        total_cost:
          type: number
        total_cost_annual:
          type: number
        unconverted:
          type: array
          items:
            $ref: '#/components/schemas/cost.UnconvertedSpend'
    responses.ErrorResponse:
      type: object
      required:
        - message
        - status
      properties:
        message:
          type: string
          example: some message
        status:
          type: string
          example: error
    cost.ProviderSpend:
      type: object
      required:
        - by_currency
        - cost
        - percent
        - provider
        - provider_name
      properties:
        by_currency:
          type: array
          items:
            $ref: '#/components/schemas/cost.CurrencySpend'
        change_percent:
          type: number
          nullable: true
        cost:
          type: number
        percent:
          type: number
        provider:
          type: string
        provider_name:
          type: string
    cost.UnconvertedSpend:
      type: object
      required:
        - currency
        - native_total
      properties:
        currency:
          type: string
        native_total:
          type: number
    cost.CurrencySpend:
      type: object
      required:
        - converted_total
        - currency
        - native_total
      properties:
        converted_total:
          type: number
        currency:
          type: string
        native_total:
          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.