openapi.yaml

openapi: 3.0.0
info:
  title: Vantage
  description: Vantage API
  version: 2.0.0
  termsOfService: https://www.vantage.sh/terms-of-use
  contact:
    name: Vantage Support
    email: support@vantage.sh
    url: https://www.vantage.sh
  x-konfig-ignore:
    potential-incorrect-type: true
servers:
  - url: https://api.vantage.sh/v2
tags:
  - description: Operations about Costs
    name: Costs
  - description: Operations about BusinessMetrics
    name: BusinessMetrics
  - description: Operations about Folders
    name: Folders
  - description: Operations about Filters
    name: Filters
  - description: Operations about Segments
    name: Segments
  - description: Operations about Dashboards
    name: Dashboards
  - description: Operations about Teams
    name: Teams
  - description: Operations about AccessGrants
    name: AccessGrants
  - description: Operations about Notifications
    name: Notifications
  - description: Operations about VirtualTags
    name: VirtualTags
  - description: Operations about AnomalyNotifications
    name: AnomalyNotifications
  - description: Operations about Budgets
    name: Budgets
  - description: Operations about BudgetAlerts
    name: BudgetAlerts
  - description: Operations about Prices
    name: Prices
  - description: Operations about ResourceReports
    name: ResourceReports
  - description: Operations about FinancialCommitmentReports
    name: FinancialCommitmentReports
  - description: Operations about KubernetesEfficiencyReports
    name: KubernetesEfficiencyReports
  - description: Operations about AnomalyAlerts
    name: AnomalyAlerts
  - description: Operations about Workspaces
    name: Workspaces
  - description: Operations about Users
    name: Users
  - description: Operations about Pings
    name: Ping
paths:
  /workspaces:
    get:
      tags:
        - Workspaces
      operationId: Workspaces_listAccessible
      description: Return all Workspaces that the current API token has access to.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspaces'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/workspaces
                      first: https://api.vantage.com/v2/workspaces?page=1
                      next: null
                      last: https://api.vantage.com/v2/workspaces?page=1
                      prev: null
                    workspaces:
                      - token: wrkspc_f936ced69bcbf8fa
                        name: Senger and Sons
  /workspaces/{workspace_token}:
    get:
      tags:
        - Workspaces
      operationId: Workspaces_getSpecificWorkspace
      description: Return a specific Workspace.
      parameters:
        - in: path
          name: workspace_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
              examples:
                response:
                  value:
                    token: wrkspc_be2a1b2c1ebfa3c9
                    name: Crist-Simonis
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /folders:
    post:
      tags:
        - Folders
      operationId: Folders_createFolderForCostReports
      security:
        - oauth2:
            - write
      description: Create a Folder for CostReports.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createFolder'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
              examples:
                response:
                  value:
                    title: New Folder
                    token: fldr_4aabe6f482c2a9e4
                    parent_folder_token: fldr_4d29cbecf2601266
                    created_at: '2023-09-12T05:06:52Z'
                    updated_at: '2023-09-12T05:06:52Z'
                    workspace_token: wrkspc_510cc77828001f9b
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - Folders
      operationId: Folders_listCostReports
      description: Return all Folders for CostReports.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folders'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/folders
                      first: https://api.vantage.com/v2/folders?page=1
                      next: null
                      last: https://api.vantage.com/v2/folders?page=1
                      prev: null
                    folders:
                      - title: synergy
                        token: fldr_baf37f32280f5444
                        parent_folder_token: null
                        created_at: '2023-09-12T05:06:54Z'
                        updated_at: '2023-09-12T05:06:54Z'
                        workspace_token: wrkspc_f583a08beb76f679
                      - title: website
                        token: fldr_625d4591e46f7dfa
                        parent_folder_token: fldr_baf37f32280f5444
                        created_at: '2023-09-12T05:06:54Z'
                        updated_at: '2023-09-12T05:06:54Z'
                        workspace_token: wrkspc_f583a08beb76f679
  /folders/{folder_token}:
    delete:
      tags:
        - Folders
      operationId: Folders_deleteFolderForCostReports
      security:
        - oauth2:
            - write
      description: Delete a Folder for CostReports.
      parameters:
        - in: path
          name: folder_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    put:
      tags:
        - Folders
      operationId: Folders_updateFolderForCostReports
      security:
        - oauth2:
            - write
      description: Update a Folder for CostReports.
      parameters:
        - in: path
          name: folder_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateFolder'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
              examples:
                response:
                  value:
                    title: New Title
                    token: fldr_68e18d8d7df0be96
                    parent_folder_token: fldr_9aa0c735a6b615c6
                    created_at: '2023-09-12T05:06:53Z'
                    updated_at: '2023-09-12T05:06:53Z'
                    workspace_token: wrkspc_e65a48e5d9684439
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - Folders
      operationId: Folders_getSpecificFolder
      description: Return a specific Folder for CostReports.
      parameters:
        - in: path
          name: folder_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
              examples:
                response:
                  value:
                    title: intermediate
                    token: fldr_3653e0f460786b1e
                    parent_folder_token: fldr_b6bf120a1d3a794b
                    created_at: '2023-09-12T05:07:36Z'
                    updated_at: '2023-09-12T05:07:36Z'
                    workspace_token: wrkspc_a707105ff54966c3
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /saved_filters:
    post:
      tags:
        - Filters
      operationId: Filters_createSavedFilterForCostReports
      security:
        - oauth2:
            - write
      description: Create a SavedFilter for CostReports.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createSavedFilter'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedFilter'
              examples:
                response:
                  value:
                    title: New Saved Filter
                    token: svd_fltr_84a8a4e35a845f97
                    cost_report_tokens: []
                    filter: (costs.provider = 'datadog')
                    created_at: '2023-09-12T05:06:52Z'
                    created_by: usr_4011f2b8a607729d
                    workspace_token: wrkspc_6f54abb1b2a5aefc
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: UnprocessableEntity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - Filters
      operationId: Filters_getCostReportFilters
      description: Return all SavedFilters that can be applied to a CostReport.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedFilters'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/saved_filters
                      first: https://api.vantage.com/v2/saved_filters?page=1
                      next: null
                      last: https://api.vantage.com/v2/saved_filters?page=1
                      prev: null
                    saved_filters:
                      - title: White
                        token: svd_fltr_52a89bb6b1c84380
                        cost_report_tokens:
                          - rprt_fef8f7e70f993108
                        filter: (costs.provider = 'aws' AND costs.account_id = '74')
                        created_at: '2023-09-12T05:07:35Z'
                        created_by: usr_055cb925f37bfa75
                        workspace_token: wrkspc_c3a582b964a67afd
  /saved_filters/{saved_filter_token}:
    delete:
      tags:
        - Filters
      operationId: Filters_deleteSavedFilter
      security:
        - oauth2:
            - write
      description: Delete a SavedFilter for CostReports.
      parameters:
        - in: path
          name: saved_filter_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedFilter'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    put:
      tags:
        - Filters
      operationId: Filters_updateSavedFilterForCostReports
      security:
        - oauth2:
            - write
      description: Update a SavedFilter for CostReports.
      parameters:
        - in: path
          name: saved_filter_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateSavedFilter'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedFilter'
              examples:
                response:
                  value:
                    title: Updated Saved Filter
                    token: svd_fltr_92c840f4c76c76b3
                    cost_report_tokens: []
                    filter: (costs.provider = 'azure')
                    created_at: '2023-09-12T05:07:35Z'
                    created_by: usr_fcd9ff9f8aa6bd1f
                    workspace_token: wrkspc_49c6865bb1f6356f
        '400':
          description: BadRequest
          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'
    get:
      tags:
        - Filters
      operationId: Filters_getSavedFilter
      description: Return a specific SavedFilter.
      parameters:
        - in: path
          name: saved_filter_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SavedFilter'
              examples:
                response:
                  value:
                    title: Black
                    token: svd_fltr_7d37f2b3704d1c41
                    cost_report_tokens:
                      - rprt_267f8c135c20bf99
                    filter: (costs.provider = 'aws' AND costs.account_id = '57')
                    created_at: '2023-09-12T05:07:36Z'
                    created_by: usr_86017037cec4a852
                    workspace_token: wrkspc_7020b8708f0e6556
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /cost_reports:
    post:
      tags:
        - Costs
      operationId: Costs_createReport
      security:
        - oauth2:
            - write
      description: Create a CostReport.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createCostReport'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CostReport'
              examples:
                response:
                  value:
                    title: New Cost Report
                    token: rprt_362b04093c087475
                    folder_token: fldr_819fe3807f88ff90
                    saved_filter_tokens:
                      - svd_fltr_a50b002184902819
                    business_metric_tokens_with_metadata:
                      - business_metric_token: bsnss_mtrc_bc0689f1b54094b1
                        unit_scale: per_thousand
                    filter: >-
                      costs.provider = 'aws' AND costs.service = 'Amazon Simple
                      Storage Service'
                    groupings: provider,service
                    settings:
                      include_credits: false
                      include_refunds: false
                      include_discounts: true
                      include_tax: true
                      amortize: true
                      unallocated: false
                    created_at: '2024-03-19T15:22:51Z'
                    workspace_token: wrkspc_d50edff4c3ae23b2
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: UnprocessableEntity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - Costs
      operationId: Costs_getAllCostReports
      description: Return all CostReports.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CostReports'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/cost_reports
                      first: https://api.vantage.com/v2/cost_reports?page=1
                      next: null
                      last: https://api.vantage.com/v2/cost_reports?page=1
                      prev: null
                    cost_reports:
                      - title: Untitled
                        token: rprt_e97ef22efaa6da12
                        folder_token: null
                        saved_filter_tokens:
                          - svd_fltr_cc4a422cf86f9e26
                        business_metric_tokens_with_metadata: []
                        filter: null
                        groupings: provider,service
                        settings:
                          include_credits: false
                          include_refunds: false
                          include_discounts: true
                          include_tax: true
                          amortize: true
                          unallocated: false
                        created_at: '2024-03-19T15:22:54Z'
                        workspace_token: wrkspc_3dc89ff43657f255
  /cost_reports/{cost_report_token}:
    delete:
      tags:
        - Costs
      operationId: Costs_deleteCostReport
      security:
        - oauth2:
            - write
      description: Delete a CostReport.
      parameters:
        - in: path
          name: cost_report_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CostReport'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    put:
      tags:
        - Costs
      operationId: Costs_updateReport
      security:
        - oauth2:
            - write
      description: Update a CostReport.
      parameters:
        - in: path
          name: cost_report_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateCostReport'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CostReport'
              examples:
                response:
                  value:
                    title: Updated Cost Report
                    token: rprt_77fec1422cfc25df
                    folder_token: fldr_54b65b6cb9af21d0
                    saved_filter_tokens:
                      - svd_fltr_33736ce7e17d7803
                    business_metric_tokens_with_metadata:
                      - business_metric_token: bsnss_mtrc_58c57f66d35a1ad7
                        unit_scale: per_thousand
                    filter: costs.provider = 'azure'
                    groupings: service,account_id
                    settings:
                      include_credits: false
                      include_refunds: false
                      include_discounts: true
                      include_tax: true
                      amortize: true
                      unallocated: false
                    created_at: '2024-03-19T15:22:52Z'
                    workspace_token: wrkspc_ca0b4a774e8fa57c
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - Costs
      operationId: Costs_getCostReport
      description: Return a CostReport.
      parameters:
        - in: path
          name: cost_report_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CostReport'
              examples:
                response:
                  value:
                    title: Segment Report
                    token: rprt_16a4d01d67a50631
                    folder_token: fldr_fa3d9420651c11d7
                    business_metric_tokens_with_metadata: []
                    filter: null
                    groupings: null
                    settings:
                      include_credits: false
                      include_refunds: false
                      include_discounts: true
                      include_tax: true
                      amortize: true
                      unallocated: false
                    created_at: '2024-03-19T15:22:54Z'
                    workspace_token: wrkspc_6a917500aba6bca8
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /segments:
    post:
      tags:
        - Segments
      operationId: Segments_createSegment
      security:
        - oauth2:
            - write
      description: Create a Segment.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createSegment'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Segment'
              examples:
                response:
                  value:
                    title: New Segment
                    description: I'm a Segment.
                    token: fltr_sgmt_1e47944f3821d5c3
                    parent_segment_token: fltr_sgmt_ac17f90b94f8d00f
                    track_unallocated: false
                    priority: 100
                    filter: >-
                      (costs.provider = 'aws' AND costs.service = 'Amazon Simple
                      Storage Service')
                    created_at: '2024-02-02T01:02:08Z'
                    workspace_token: wrkspc_d5d4814d5e42522c
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: UnprocessableEntity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - Segments
      operationId: Segments_list
      description: Return all Segments.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Segments'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/segments
                      first: https://api.vantage.com/v2/segments?page=1
                      next: null
                      last: https://api.vantage.com/v2/segments?page=1
                      prev: null
                    segments:
                      - title: installation
                        description: Multi-lateral attitude-oriented process improvement
                        token: fltr_sgmt_0db07f2863f779cc
                        parent_segment_token: null
                        track_unallocated: false
                        report_settings:
                          include_credits: false
                          include_refunds: false
                          include_discounts: true
                          include_tax: true
                          amortize: true
                        priority: 100
                        filter: (costs.provider = 'aws')
                        created_at: '2024-02-02T01:02:07Z'
                        workspace_token: wrkspc_7036b752bf43a658
  /segments/{segment_token}:
    delete:
      tags:
        - Segments
      operationId: Segments_removeSegment
      security:
        - oauth2:
            - write
      description: Delete a Segment.
      parameters:
        - in: path
          name: segment_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Segment'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    put:
      tags:
        - Segments
      operationId: Segments_updateSegmentById
      security:
        - oauth2:
            - write
      description: Update a Segment.
      parameters:
        - in: path
          name: segment_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateSegment'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Segment'
              examples:
                response:
                  value:
                    title: Updated Segment
                    description: Ameliorated disintermediate challenge
                    token: fltr_sgmt_99969c652d4df258
                    parent_segment_token: fltr_sgmt_d8d4da2ef1751c13
                    track_unallocated: false
                    priority: 42
                    filter: (costs.provider = 'azure')
                    created_at: '2024-02-02T01:05:01Z'
                    workspace_token: wrkspc_c144e5f763a5b05e
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - Segments
      operationId: Segments_getSegmentById
      description: Return a Segment.
      parameters:
        - in: path
          name: segment_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Segment'
              examples:
                response:
                  value:
                    title: benchmark
                    description: Synergized bandwidth-monitored help-desk
                    token: fltr_sgmt_d1de6bdb3133d61e
                    parent_segment_token: null
                    track_unallocated: false
                    report_settings:
                      include_credits: false
                      include_refunds: false
                      include_discounts: true
                      include_tax: true
                      amortize: true
                    priority: 100
                    filter: (costs.provider = 'aws')
                    created_at: '2024-02-02T01:02:09Z'
                    workspace_token: wrkspc_5c9b1211804105ff
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /dashboards:
    post:
      tags:
        - Dashboards
        - Costs
      operationId: Dashboards_createDashboard
      security:
        - oauth2:
            - write
      description: Create a Dashboard.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createDashboard'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
              examples:
                response:
                  value:
                    title: New Dashboard
                    token: dshbrd_40d2a85e60872ee4
                    widget_tokens:
                      - rprt_d1262358f4d2de03
                    saved_filter_tokens:
                      - svd_fltr_03bae07fb40ef1e0
                    date_bin: week
                    date_interval: this_month
                    start_date: '2023-08-01'
                    end_date: '2023-08-31'
                    created_at: '2023-08-15T00:00:00Z'
                    updated_at: '2023-08-15T00:00:00Z'
                    workspace_token: wrkspc_7c586d05929f60b4
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - Dashboards
        - Costs
      operationId: Dashboards_getAll
      description: Return all Dashboards.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboards'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/dashboards
                      first: https://api.vantage.com/v2/dashboards?page=1
                      next: null
                      last: https://api.vantage.com/v2/dashboards?page=1
                      prev: null
                    dashboards:
                      - title: O Jerusalem!
                        token: dshbrd_0e00316c1b6ccdf5
                        widget_tokens:
                          - rprt_63e2ca172354d16a
                        saved_filter_tokens:
                          - svd_fltr_447e67636b3c789a
                        date_bin: null
                        date_interval: null
                        start_date: null
                        end_date: null
                        created_at: '2024-03-04T18:49:33Z'
                        updated_at: '2024-03-04T18:49:33Z'
                        workspace_token: wrkspc_d42986a4825b18c7
  /dashboards/{dashboard_token}:
    delete:
      tags:
        - Dashboards
        - Costs
      operationId: Dashboards_deleteDashboard
      security:
        - oauth2:
            - write
      description: Delete a Dashboard.
      parameters:
        - in: path
          name: dashboard_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    put:
      tags:
        - Dashboards
        - Costs
      operationId: Dashboards_updateDashboard
      security:
        - oauth2:
            - write
      description: Update a Dashboard.
      parameters:
        - in: path
          name: dashboard_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateDashboard'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
              examples:
                response:
                  value:
                    title: Updated Dashboard
                    token: dshbrd_43f0df22a2b28fc1
                    widget_tokens:
                      - rprt_1f78a31ae74c183f
                    saved_filter_tokens:
                      - svd_fltr_c90a915a9b8c4128
                    date_bin: week
                    date_interval: this_month
                    start_date: '2023-08-01'
                    end_date: '2023-08-31'
                    created_at: '2024-03-04T18:49:32Z'
                    updated_at: '2023-08-15T00:00:00Z'
                    workspace_token: wrkspc_1f7d72cc9302b876
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - Dashboards
        - Costs
      operationId: Dashboards_getSpecificDashboard
      description: Return a specific Dashboard.
      parameters:
        - in: path
          name: dashboard_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/dashboards
                      first: https://api.vantage.com/v2/dashboards?page=1
                      next: null
                      last: https://api.vantage.com/v2/dashboards?page=1
                      prev: null
                    dashboards:
                      - title: The Road Less Traveled
                        token: dshbrd_77736ea6e502a481
                        widget_tokens:
                          - rprt_7d955d7fbe334706
                        saved_filter_tokens:
                          - svd_fltr_cd8f90c99b33dfa6
                        date_bin: null
                        date_interval: null
                        start_date: null
                        end_date: null
                        created_at: '2024-03-04T18:49:33Z'
                        updated_at: '2024-03-04T18:49:33Z'
                        workspace_token: wrkspc_863089db412905d9
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /costs:
    get:
      tags:
        - Costs
      operationId: Costs_listCostReport
      description: Return all Costs for a CostReport.
      parameters:
        - description: The CostReport token.
          in: query
          name: cost_report_token
          required: true
          schema:
            type: string
        - description: First date you would like to filter costs from. ISO 8601 formatted.
          in: query
          name: start_date
          required: false
          schema:
            type: string
        - description: Last date you would like to filter costs to. ISO 8601 formatted.
          in: query
          name: end_date
          required: false
          schema:
            type: string
        - description: >-
            Group the results by specific field(s). Defaults to provider,
            service, account_id. Valid groupings: account_id,
            billing_account_id, charge_type, cost_category, cost_subcategory,
            provider, region, resource_id, service, tagged, tag:<tag_value>. If
            providing multiple groupings, join as comma separated values:
            groupings=provider,service,region
          in: query
          name: groupings
          required: false
          style: form
          explode: false
          schema:
            type: array
            items:
              type: string
        - description: Whether to order costs by date in an ascending or descending manner.
          in: query
          name: order
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Costs'
              examples:
                response:
                  value:
                    links:
                      self: >-
                        https://api.vantage.com/v2/costs?cost_report_token=rprt_ea7dbb4f5783d677
                      first: >-
                        https://api.vantage.com/v2/costs?cost_report_token=rprt_ea7dbb4f5783d677&page=1
                      next: null
                      last: >-
                        https://api.vantage.com/v2/costs?cost_report_token=rprt_ea7dbb4f5783d677&page=1
                      prev: null
                    total_cost:
                      amount: '500.0'
                      currency: USD
                    costs:
                      - accrued_at: '2023-06-05'
                        amount: '100.0'
                        currency: USD
                        provider: aws
                        account_id: mock_56789
                        service: AmazonSNS
                      - accrued_at: '2023-06-04'
                        amount: '100.0'
                        currency: USD
                        provider: aws
                        account_id: mock_56789
                        service: AmazonSNS
                      - accrued_at: '2023-06-03'
                        amount: '100.0'
                        currency: USD
                        provider: aws
                        account_id: mock_56789
                        service: AmazonSNS
                      - accrued_at: '2023-06-02'
                        amount: '100.0'
                        currency: USD
                        provider: aws
                        account_id: mock_56789
                        service: AmazonSNS
                      - accrued_at: '2023-06-01'
                        amount: '100.0'
                        currency: USD
                        provider: aws
                        account_id: mock_56789
                        service: AmazonSNS
        '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'
  /teams:
    post:
      tags:
        - Teams
      operationId: Teams_createNewTeam
      security:
        - oauth2:
            - write
      description: Create a new Team.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createTeam'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Team'
              examples:
                response:
                  value:
                    description: New Team Description
                    token: team_8467157535a30221
                    name: New Team
                    workspace_tokens:
                      - wrkspc_52b6e5e663b4cde1
                    user_tokens:
                      - usr_a00e614b5843c234
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          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'
    get:
      tags:
        - Teams
      operationId: Teams_listAccessible
      description: Return all Teams that the current API token has access to.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Teams'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/teams
                      first: https://api.vantage.com/v2/teams?page=1
                      next: null
                      last: https://api.vantage.com/v2/teams?page=1
                      prev: null
                    teams:
                      - description: Consequuntur ratione.
                        token: team_2d4733920ec4385e
                        name: New Mexico people
                        workspace_tokens:
                          - wrkspc_08026aa5fb4c90f8
                        user_tokens:
                          - usr_c59398553e838116
  /teams/{team_token}:
    delete:
      tags:
        - Teams
      operationId: Teams_removeTeam
      security:
        - oauth2:
            - write
      description: Delete a Team.
      parameters:
        - in: path
          name: team_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Team'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          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'
    put:
      tags:
        - Teams
      operationId: Teams_updateTeam
      security:
        - oauth2:
            - write
      description: Update a Team.
      parameters:
        - in: path
          name: team_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateTeam'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Team'
              examples:
                response:
                  value:
                    description: Updated Team Description
                    token: team_d617e73dcc6b57c5
                    name: Updated Team
                    workspace_tokens:
                      - wrkspc_efc4284a56772481
                    user_tokens:
                      - usr_d268561e520c7aac
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          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'
    get:
      tags:
        - Teams
      operationId: Teams_getSpecificTeam
      description: Return a specific Team.
      parameters:
        - in: path
          name: team_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Team'
              examples:
                response:
                  value:
                    description: Voluptas et.
                    token: team_081e09bbb812d369
                    name: Missouri cats
                    workspace_tokens:
                      - wrkspc_ddc003a2f0171bf8
                    user_tokens:
                      - usr_7c309915e847cfc6
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /access_grants:
    post:
      tags:
        - AccessGrants
      operationId: AccessGrants_createGrant
      security:
        - oauth2:
            - write
      description: Create an Access Grant.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createAccessGrant'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessGrant'
              examples:
                response:
                  value:
                    token: rsrc_accss_grnt_9f8aeb3cedda3831
                    resource_token: rprt_3b935d26cba36fb0
                    access: denied
                    team_token: team_26865e16e46028ae
                    created_at: '2024-01-18T17:39:37Z'
                    created_by: usr_2fc38883da3726b9
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '406':
          description: NotAcceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: UnprocessableEntity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - AccessGrants
      operationId: AccessGrants_listAccessible
      description: Return all Access Grants that the current API token has access to.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessGrants'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/access_grants
                      first: https://api.vantage.com/v2/access_grants?page=1
                      next: null
                      last: https://api.vantage.com/v2/access_grants?page=1
                      prev: null
                    access_grants:
                      - token: rsrc_accss_grnt_c40f15062b6d5c37
                        resource_token: rprt_5a269d316483b01c
                        access: denied
                        team_token: team_fd5c524ba104712b
                        created_at: '2024-01-18T17:39:37Z'
                        created_by: usr_eb8ce6bdc1fa31d5
                      - token: rsrc_accss_grnt_9723e984e93d8907
                        resource_token: dshbrd_a08561ec24875ac9
                        access: allowed
                        team_token: team_fd5c524ba104712b
                        created_at: '2024-01-18T17:39:37Z'
                        created_by: usr_eb8ce6bdc1fa31d5
                      - token: rsrc_accss_grnt_eee5c4fd777d4dc8
                        resource_token: fldr_9d4ad1a769131c58
                        access: allowed
                        team_token: team_fd5c524ba104712b
                        created_at: '2024-01-18T17:39:38Z'
                        created_by: usr_eb8ce6bdc1fa31d5
  /access_grants/{access_grant_token}:
    delete:
      tags:
        - AccessGrants
      operationId: AccessGrants_delete
      security:
        - oauth2:
            - write
      description: Delete an Access Grant.
      parameters:
        - in: path
          name: access_grant_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessGrant'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    put:
      tags:
        - AccessGrants
      operationId: AccessGrants_updateGrantToken
      security:
        - oauth2:
            - write
      description: Update an AccessGrant.
      parameters:
        - in: path
          name: access_grant_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateAccessGrant'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessGrant'
              examples:
                response:
                  value:
                    token: rsrc_accss_grnt_eea11f0d35318b0d
                    resource_token: rprt_e84d7760ab2dd7dc
                    access: allowed
                    team_token: team_25fc4aa890869602
                    created_at: '2024-01-18T17:39:36Z'
                    created_by: usr_57ed2fa2a7b30166
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - AccessGrants
      operationId: AccessGrants_getSpecificGrant
      description: Return a specific Access Grant.
      parameters:
        - in: path
          name: access_grant_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessGrant'
              examples:
                response:
                  value:
                    token: rsrc_accss_grnt_07ed83a5069b91c4
                    resource_token: rprt_b8df14aa8a4ad5c7
                    access: denied
                    team_token: team_14bd13a8bccb8406
                    created_at: '2024-01-18T17:39:36Z'
                    created_by: usr_0e1cb254743b26cb
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /report_notifications:
    post:
      tags:
        - Notifications
      operationId: Notifications_createReportNotification
      security:
        - oauth2:
            - write
      description: Create a ReportNotification.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createReportNotification'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportNotification'
              examples:
                response:
                  value:
                    title: New Report Notification
                    token: rprt_ntfctn_8ce31b43a149cd2e
                    cost_report_token: rprt_933010600676b02f
                    user_tokens:
                      - usr_45e7d17e9f402226
                    frequency: daily
                    change: percentage
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: UnprocessableEntity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - Notifications
      operationId: Notifications_getAllReportNotifications
      description: Return all ReportNotifications.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportNotifications'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/report_notifications
                      first: https://api.vantage.com/v2/report_notifications?page=1
                      next: null
                      last: https://api.vantage.com/v2/report_notifications?page=1
                      prev: null
                    report_notifications:
                      - title: Test Notification
                        token: rprt_ntfctn_7c09ca27d07d8d1e
                        cost_report_token: rprt_ba0a5a5201390d72
                        user_tokens:
                          - usr_27edb13f3beac3cb
                        frequency: weekly
                        change: percentage
  /report_notifications/{report_notification_token}:
    delete:
      tags:
        - Notifications
      operationId: Notifications_deleteReportNotification
      security:
        - oauth2:
            - write
      description: Delete a ReportNotification.
      parameters:
        - in: path
          name: report_notification_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportNotification'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    put:
      tags:
        - Notifications
      operationId: Notifications_updateReportNotification
      security:
        - oauth2:
            - write
      description: Update a ReportNotification.
      parameters:
        - in: path
          name: report_notification_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateReportNotification'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportNotification'
              examples:
                response:
                  value:
                    title: Updated Report Notification
                    token: rprt_ntfctn_b36b208a90ee87f6
                    cost_report_token: rprt_07b88c04aa6bed8c
                    user_tokens:
                      - usr_35ed19fadcfed8c9
                    frequency: weekly
                    change: dollars
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - Notifications
      operationId: Notifications_getReportNotification
      description: Return a ReportNotification.
      parameters:
        - in: path
          name: report_notification_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportNotification'
              examples:
                response:
                  value:
                    title: Test Notification
                    token: rprt_ntfctn_21b4287a212406b1
                    cost_report_token: rprt_d084c84455edc606
                    user_tokens:
                      - usr_56d53f802edba3e6
                    frequency: weekly
                    change: percentage
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /users:
    get:
      tags:
        - Users
      operationId: Users_listAccessible
      description: Return all Users that the current API token has access to.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Users'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/users
                      first: https://api.vantage.com/v2/users?page=1
                      next: null
                      last: https://api.vantage.com/v2/users?page=1
                      prev: null
                    users:
                      - token: usr_3f30f56e7773e72b
                        name: Pres. Sudie Kuvalis
                        email: kuvalis.sudie.pres@mckenzie-herman.net
                        role: Owner
                      - token: usr_dc69dfedf704d4ea
                        name: Carisa Tromp
                        email: carisa.tromp@morissette.co
                        role: Viewer
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /users/{user_token}:
    get:
      tags:
        - Users
      operationId: Users_getSpecificUser
      description: Return a specific User.
      parameters:
        - in: path
          name: user_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
              examples:
                response:
                  value:
                    token: usr_92c7273af4de2fb4
                    name: Miss Shirlene Weissnat
                    email: miss.shirlene.weissnat@west-howe.net
                    role: Owner
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /business_metrics:
    post:
      tags:
        - BusinessMetrics
      operationId: BusinessMetrics_createNewMetric
      security:
        - oauth2:
            - write
      description: Create a new BusinessMetric.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createBusinessMetric'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessMetric'
              examples:
                response:
                  value:
                    title: New Biz Metric
                    token: bsnss_mtrc_8fd798977fbef041
                    created_by_token: usr_736c1e3753ee2900
                    cost_report_tokens_with_metadata:
                      - cost_report_token: rprt_659365dfc7f15a60
                        unit_scale: per_thousand
                    values:
                      - date: '2024-01-03T00:00:00Z'
                        amount: '300.0'
                      - date: '2024-01-02T00:00:00Z'
                        amount: '200.0'
                      - date: '2024-01-01T00:00:00Z'
                        amount: '100.0'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          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'
    get:
      tags:
        - BusinessMetrics
      operationId: BusinessMetrics_getAllMetrics
      description: Return all BusinessMetrics that the current API token has access to.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessMetrics'
              examples:
                response:
                  value:
                    business_metrics:
                      - title: Biz Metric
                        token: bsnss_mtrc_731b7041ac0e8639
                        created_by_token: null
                        cost_report_tokens_with_metadata: []
                        values: []
  /business_metrics/{business_metric_token}:
    delete:
      tags:
        - BusinessMetrics
      operationId: BusinessMetrics_deleteExistingMetric
      security:
        - oauth2:
            - write
      description: Deletes an existing BusinessMetric.
      parameters:
        - in: path
          name: business_metric_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessMetric'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    put:
      tags:
        - BusinessMetrics
      operationId: BusinessMetrics_updateExistingMetric
      security:
        - oauth2:
            - write
      description: Updates an existing BusinessMetric.
      parameters:
        - in: path
          name: business_metric_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateBusinessMetric'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessMetric'
              examples:
                response:
                  value:
                    title: New Title
                    token: bsnss_mtrc_f61afeebb9482934
                    created_by_token: null
                    cost_report_tokens_with_metadata:
                      - cost_report_token: rprt_d0b678c7275142fa
                        unit_scale: per_thousand
                    values:
                      - date: '2024-01-03T00:00:00Z'
                        amount: '600.0'
                      - date: '2024-01-02T00:00:00Z'
                        amount: '500.0'
                      - date: '2024-01-01T00:00:00Z'
                        amount: '400.0'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          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'
    get:
      tags:
        - BusinessMetrics
      operationId: BusinessMetrics_getMetricById
      description: Return a specific BusinessMetrics.
      parameters:
        - in: path
          name: business_metric_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessMetric'
              examples:
                response:
                  value:
                    title: Biz Metric
                    token: bsnss_mtrc_20b28191d23d5bee
                    created_by_token: null
                    cost_report_tokens_with_metadata: []
                    values: []
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /business_metrics/{business_metric_token}/values.csv:
    put:
      tags:
        - BusinessMetrics
      operationId: BusinessMetrics_updateValuesCsv
      security:
        - oauth2:
            - write
      description: Updates the values for an existing BusinessMetric from a CSV file.
      parameters:
        - in: path
          name: business_metric_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BusinessMetricsUpdateValuesCsvRequest'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessMetric'
              examples:
                response:
                  value:
                    title: Biz Metric
                    token: bsnss_mtrc_20326908a5f928d8
                    created_by_token: null
                    cost_report_tokens_with_metadata: []
                    values:
                      - date: '2024-01-03T00:00:00Z'
                        amount: '300.3'
                      - date: '2024-01-02T00:00:00Z'
                        amount: '200.2'
                      - date: '2024-01-01T00:00:00Z'
                        amount: '100.1'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          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'
  /products:
    get:
      tags:
        - Prices
      operationId: Prices_listAvailableProducts
      description: >-
        Return available Products for a Service. For example, with a Provider of
        AWS and a Service of EC2, Products will be a list of all EC2 Instances.
        By default, this endpoint returns all Products across all Services and
        Providers but has optional query parameters for filtering listed below.
      parameters:
        - description: >-
            Query by Provider to list all Products across all Services for a
            Provider. e.g. aws
          in: query
          name: provider_id
          required: false
          schema:
            type: string
        - description: >-
            Query by Service to list all Products for a specific provider
            service. e.g. aws-ec2
          in: query
          name: service_id
          required: false
          schema:
            type: string
        - description: >-
            Query by name of the Product to see a list of products which match
            that name. e.g. m5a.16xlarge
          in: query
          name: name
          required: false
          schema:
            type: string
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Products'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v1/products
                      first: https://api.vantage.com/v1/products?page=1
                      next: null
                      last: https://api.vantage.com/v1/products?page=1
                      prev: null
                    products:
                      - id: aws-ec2-m5d_16xlarge
                        category: compute
                        name: m5d.16xlarge
                        service_id: aws-ec2
                        provider_id: aws
                        details:
                          gpu: 0
                          name: M5 General Purpose 16xlarge
                          vcpu: 64
                          memory: 256
                          clock_speed_ghz: 3.1
                          physical_processor_description: Intel Xeon Platinum 8175 (Skylake)
                          network_performance_description: 20 Gigabit
                      - id: aws-ec2-c5a_8xlarge
                        category: compute
                        name: c5a.8xlarge
                        service_id: aws-ec2
                        provider_id: aws
                        details:
                          gpu: 0
                          name: C5A 8xlarge
                          vcpu: 64
                          memory: 256
                      - id: aws-ec2-c5a_4large
                        category: compute
                        name: c5a.4large
                        service_id: aws-ec2
                        provider_id: aws
                        details:
                          gpu: 0
                          name: C5A 4large
                          vcpu: 64
                          memory: 4
                      - id: aws-s3-standard
                        category: object_storage
                        name: standard
                        service_id: aws-s3
                        provider_id: aws
                        details: {}
  /products/{id}:
    get:
      tags:
        - Prices
      operationId: Prices_getProduct
      description: Return a product
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Product'
              examples:
                response:
                  value:
                    id: aws-ec2-m5d_16xlargeX
                    category: compute
                    name: m5d.16xlarge
                    service_id: aws-ec2
                    provider_id: aws
                    details:
                      gpu: 0
                      name: M5 General Purpose 16xlarge
                      vcpu: 64
                      memory: 256
                      clock_speed_ghz: 3.1
                      physical_processor_description: Intel Xeon Platinum 8175 (Skylake)
                      network_performance_description: 20 Gigabit
  /products/{product_id}/prices:
    get:
      tags:
        - Prices
      operationId: Prices_getProductPrices
      description: Return available Prices across all Regions for a Product.
      parameters:
        - in: path
          name: product_id
          required: true
          schema:
            type: string
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Prices'
              examples:
                response:
                  value:
                    links:
                      self: >-
                        https://api.vantage.com/v1/products/aws-ec2-m5d_16xlarge/prices
                      first: >-
                        https://api.vantage.com/v1/products/aws-ec2-m5d_16xlarge/prices?page=1
                      next: null
                      last: >-
                        https://api.vantage.com/v1/products/aws-ec2-m5d_16xlarge/prices?page=1
                      prev: null
                    prices:
                      - id: >-
                          aws-ec2-m5d_16xlarge-eu_central_1-on_demand-linux_enterprise
                        unit: hour
                        region: eu-central-1
                        rate_type: compute
                        currency: USD
                        amount: 27.328
                        details:
                          platform: linux-enterprise
                          lifecycle: on-demand
                      - id: >-
                          aws-ec2-m5d_16xlarge-us_east_1-on_demand-linux_enterprise
                        unit: hour
                        region: us-east-1
                        rate_type: compute
                        currency: USD
                        amount: 3.616
                        details:
                          platform: linux-enterprise
                          lifecycle: on-demand
                      - id: aws-ec2-m5d_16xlarge-us_east_1-on_demand-rhel
                        unit: hour
                        region: us-east-1
                        rate_type: compute
                        currency: USD
                        amount: 3.746
                        details:
                          platform: rhel
                          lifecycle: on-demand
  /products/{product_id}/prices/{id}:
    get:
      tags:
        - Prices
      operationId: Prices_getProductPrice
      description: Returns a price
      parameters:
        - in: path
          name: product_id
          required: true
          schema:
            type: string
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Price'
              examples:
                response:
                  value:
                    id: >-
                      aws-ec2-m5d_16xlarge-eu_central_1-on_demand-linux_enterpriseX
                    unit: hour
                    region: eu-central-1
                    rate_type: compute
                    currency: USD
                    amount: 27.328
                    details:
                      platform: linux-enterprise
                      lifecycle: on-demand
  /resource_reports:
    get:
      tags:
        - ResourceReports
      operationId: ResourceReports_getAll
      description: Return all ResourceReports.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The number of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceReports'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/provider_resource_reports
                      first: >-
                        https://api.vantage.com/v2/provider_resource_reports?page=1
                      next: null
                      last: >-
                        https://api.vantage.com/v2/provider_resource_reports?page=1
                      prev: null
                    provider_resource_reports:
                      - title: Resource Report 098e130a
                        token: prvdr_rsrc_rprt_c013a8c9280ed485
                        default: false
                        created_at: '2024-03-19T22:09:43Z'
                        workspace_token: wrkspc_5a15339e6128797f
                        report_token: null
                        user_token: null
                        recommendation_service: null
                        recommendation_category: null
  /resource_reports/{resource_report_token}:
    delete:
      tags:
        - ResourceReports
      operationId: ResourceReports_removeReport
      security:
        - oauth2:
            - write
      description: Delete a ResourceReport.
      parameters:
        - in: path
          name: resource_report_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceReport'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - ResourceReports
      operationId: ResourceReports_getResourceReport
      description: Return a ResourceReport.
      parameters:
        - in: path
          name: resource_report_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceReport'
              examples:
                response:
                  value:
                    title: Resource Report 46d7371d
                    token: prvdr_rsrc_rprt_b4b9884d0bb2e121
                    default: false
                    created_at: '2024-03-19T22:09:43Z'
                    workspace_token: wrkspc_3b72a68131df0d33
                    report_token: null
                    user_token: null
                    recommendation_service: null
                    recommendation_category: null
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /financial_commitment_reports:
    get:
      tags:
        - FinancialCommitmentReports
      operationId: FinancialCommitmentReports_getAllReports
      description: Return all FinancialCommitmentReports.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialCommitmentReports'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/financial_commitment_reports
                      first: >-
                        https://api.vantage.com/v2/financial_commitment_reports?page=1
                      next: null
                      last: >-
                        https://api.vantage.com/v2/financial_commitment_reports?page=1
                      prev: null
                    financial_commitment_reports:
                      - title: All Financial Commitments
                        token: fncl_cmnt_rprt_8856c4e96c5a7a0e
                        default: false
                        created_at: '2024-03-28T18:26:26Z'
                        workspace_token: wrkspc_1ca9ae316e86906f
                        user_token: null
                        start_date: '2023-12-01'
                        end_date: '2024-03-26'
                        date_interval: last_3_months
                        date_bucket: month
                        groupings: cost_type
                        on_demand_costs_scope: discountable
  /financial_commitment_reports/{financial_commitment_report_token}:
    delete:
      tags:
        - FinancialCommitmentReports
      operationId: FinancialCommitmentReports_deleteReport
      security:
        - oauth2:
            - write
      description: Delete a FinancialCommitmentReport.
      parameters:
        - in: path
          name: financial_commitment_report_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialCommitmentReport'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - FinancialCommitmentReports
      operationId: FinancialCommitmentReports_get
      description: Return a FinancialCommitmentReport.
      parameters:
        - in: path
          name: financial_commitment_report_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialCommitmentReport'
              examples:
                response:
                  value:
                    title: All Financial Commitments
                    token: fncl_cmnt_rprt_674cf1d6ef5f55e5
                    default: false
                    created_at: '2024-03-28T18:26:26Z'
                    workspace_token: wrkspc_075ac35ab0dc1b4a
                    user_token: null
                    start_date: '2023-12-01'
                    end_date: '2024-03-26'
                    date_interval: last_3_months
                    date_bucket: month
                    groupings: cost_type
                    on_demand_costs_scope: discountable
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /kubernetes_efficiency_reports:
    get:
      tags:
        - KubernetesEfficiencyReports
      operationId: KubernetesEfficiencyReports_getAll
      description: Return all KubernetesEfficiencyReports.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KubernetesEfficiencyReports'
  /kubernetes_efficiency_reports/{kubernetes_efficiency_report_token}:
    delete:
      tags:
        - KubernetesEfficiencyReports
      operationId: KubernetesEfficiencyReports_deleteReport
      security:
        - oauth2:
            - write
      description: Delete a KubernetesEfficiencyReport.
      parameters:
        - in: path
          name: kubernetes_efficiency_report_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KubernetesEfficiencyReport'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - KubernetesEfficiencyReports
      operationId: KubernetesEfficiencyReports_getReport
      description: Return a KubernetesEfficiencyReport.
      parameters:
        - in: path
          name: kubernetes_efficiency_report_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KubernetesEfficiencyReport'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /anomaly_alerts:
    get:
      tags:
        - AnomalyAlerts
      operationId: AnomalyAlerts_listAccessible
      description: Return all Anomaly Alerts that the current API token has access to.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyAlerts'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/anomaly_alerts
                      first: https://api.vantage.com/v2/anomaly_alerts?page=1
                      next: null
                      last: https://api.vantage.com/v2/anomaly_alerts?page=1
                      prev: null
                    anomaly_alerts:
                      - token: anmly_alrt_e1fb8184ecdf129d
                        created_at: '2024-04-01T17:14:45Z'
                        alerted_at: '2024-04-01T17:14:45Z'
                        category: Compute
                        service: AmazonEKS
                        provider: aws
                        amount: '100.0'
                        previous_amount: '25.0'
                        seven_day_average: '10.0'
                        status: active
                        feedback: null
                        cost_report_token: rprt_3d541a4c5160711f
  /anomaly_alerts/{anomaly_alert_token}:
    put:
      tags:
        - AnomalyAlerts
      operationId: AnomalyAlerts_updateAlert
      security:
        - oauth2:
            - write
      description: Update an AnomalyAlert.
      parameters:
        - in: path
          name: anomaly_alert_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateAnomalyAlert'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyAlert'
              examples:
                response:
                  value:
                    token: anmly_alrt_51a2ce4137305fc6
                    created_at: '2024-04-01T17:14:46Z'
                    alerted_at: '2024-04-01T17:14:46Z'
                    category: Compute
                    service: AmazonEKS
                    provider: aws
                    amount: '100.0'
                    previous_amount: '25.0'
                    seven_day_average: '10.0'
                    status: archived
                    feedback: this stinks
                    cost_report_token: rprt_57912c584fdf88f4
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          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'
    get:
      tags:
        - AnomalyAlerts
      operationId: AnomalyAlerts_getByToken
      description: Return an AnomalyAlert that the current API token has access to.
      parameters:
        - in: path
          name: anomaly_alert_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyAlert'
              examples:
                response:
                  value:
                    token: anmly_alrt_6056b98225236ece
                    created_at: '2024-04-01T17:14:45Z'
                    alerted_at: '2024-04-01T17:14:45Z'
                    category: Compute
                    service: AmazonEKS
                    provider: aws
                    amount: '100.0'
                    previous_amount: '25.0'
                    seven_day_average: '10.0'
                    status: active
                    feedback: null
                    cost_report_token: rprt_bf0a30084fbf52c2
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /virtual_tag_configs:
    post:
      tags:
        - VirtualTags
      operationId: VirtualTags_createNewConfig
      security:
        - oauth2:
            - write
      description: Create a new VirtualTagConfig.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createVirtualTagConfig'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualTagConfig'
              examples:
                response:
                  value:
                    token: vtag_f4a84302f614d658
                    created_by_token: usr_b594fc347b8216fc
                    key: Expense Code
                    overridable: false
                    backfill_until: '2024-04-01'
                    values:
                      - name: EXPC-1234
                        filter: >-
                          (costs.provider = 'aws' AND costs.service = 'Amazon
                          Elastic Compute Cloud') AND (costs.provider = 'aws'
                          AND costs.account_id IN ('1234', '5678'))
                      - name: EXPC-9876
                        filter: >-
                          (costs.provider = 'aws' AND costs.account_id IN
                          ('1234', '5678')) OR (costs.provider = 'gcp' AND
                          costs.service = 'Google Compute Engine')
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          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'
    get:
      tags:
        - VirtualTags
      operationId: VirtualTags_getAll
      description: Return all VirtualTagConfigs that the current API token has access to.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualTagConfigs'
              examples:
                response:
                  value:
                    virtual_tag_configs:
                      - token: vtag_8ec959d189f5e069
                        created_by_token: usr_95037e6816d8274c
                        key: Product Team
                        overridable: false
                        backfill_until: '2024-04-01'
                        values:
                          - name: Growth
                            filter: >-
                              (costs.provider = 'aws' AND costs.service =
                              'Amazon Elastic Compute Cloud') AND
                              (costs.provider = 'aws' AND costs.account_id IN
                              ('1234', '5678'))
                          - name: API
                            filter: >-
                              (costs.provider = 'aws' AND costs.account_id IN
                              ('1234', '5678')) OR (costs.provider = 'gcp' AND
                              costs.service = 'Google Compute Engine')
  /virtual_tag_configs/{virtual_tag_config_token}:
    delete:
      tags:
        - VirtualTags
      operationId: VirtualTags_deleteConfig
      security:
        - oauth2:
            - write
      description: Deletes an existing VirtualTagConfig.
      parameters:
        - in: path
          name: virtual_tag_config_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualTagConfig'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    put:
      tags:
        - VirtualTags
      operationId: VirtualTags_updateConfig
      security:
        - oauth2:
            - write
      description: Updates an existing VirtualTagConfig.
      parameters:
        - in: path
          name: virtual_tag_config_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateVirtualTagConfig'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualTagConfig'
              examples:
                response:
                  value:
                    token: vtag_a479efbaec5eb18a
                    created_by_token: usr_e490836e766d2f3b
                    key: team
                    overridable: true
                    backfill_until: '2024-04-01'
                    values:
                      - name: marketing
                        filter: >-
                          (costs.provider = 'aws' AND costs.service = 'Amazon
                          Elastic Compute Cloud') AND (costs.provider = 'aws'
                          AND costs.account_id IN ('1234', '5678'))
                      - name: third-party integrations
                        filter: >-
                          (costs.provider = 'aws' AND costs.account_id IN
                          ('1234', '5678')) OR (costs.provider = 'gcp' AND
                          costs.service = 'Google Compute Engine')
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '403':
          description: Forbidden
          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'
    get:
      tags:
        - VirtualTags
      operationId: VirtualTags_getSpecificConfig
      description: Return a specific VirtualTagConfig.
      parameters:
        - in: path
          name: virtual_tag_config_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualTagConfig'
              examples:
                response:
                  value:
                    token: vtag_d8ec602528464b61
                    created_by_token: usr_64ff4a87ec8aeef2
                    key: Product Team
                    overridable: false
                    backfill_until: '2024-04-01'
                    values:
                      - name: Growth
                        filter: >-
                          (costs.provider = 'aws' AND costs.service = 'Amazon
                          Elastic Compute Cloud') AND (costs.provider = 'aws'
                          AND costs.account_id IN ('1234', '5678'))
                      - name: API
                        filter: >-
                          (costs.provider = 'aws' AND costs.account_id IN
                          ('1234', '5678')) OR (costs.provider = 'gcp' AND
                          costs.service = 'Google Compute Engine')
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /anomaly_notifications:
    post:
      tags:
        - AnomalyNotifications
      operationId: AnomalyNotifications_createCostReportNotification
      security:
        - oauth2:
            - write
      description: Create an Anomaly Notification for a Cost Report.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createAnomalyNotification'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyNotification'
              examples:
                response:
                  value:
                    token: rprt_alrt_9b22edfa0a175609
                    cost_report_token: rprt_4c9e5f72ae27bc24
                    created_at: '2024-04-09T15:05:37Z'
                    updated_at: '2024-04-09T15:05:37Z'
                    threshold: 1
                    user_tokens:
                      - usr_3773d590e84f6f12
                    recipient_channels:
                      - channel1
                      - channel2
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - AnomalyNotifications
      operationId: AnomalyNotifications_listAll
      description: Return all Anomaly Notifications.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The amount of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyNotifications'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/anomaly_notifications
                      first: https://api.vantage.com/v2/anomaly_notifications?page=1
                      next: null
                      last: https://api.vantage.com/v2/anomaly_notifications?page=1
                      prev: null
                    anomaly_notifications:
                      - token: rprt_alrt_ecb76d8d2825762f
                        cost_report_token: rprt_45fe4d4c1779ce7e
                        created_at: '2024-04-09T15:05:37Z'
                        updated_at: '2024-04-09T15:05:37Z'
                        threshold: 10
                        user_tokens:
                          - usr_13477ee1b1eb81ba
                        recipient_channels: []
  /anomaly_notifications/{anomaly_notification_token}:
    delete:
      tags:
        - AnomalyNotifications
      operationId: AnomalyNotifications_deleteNotification
      security:
        - oauth2:
            - write
      description: Delete an Anomaly Notification.
      parameters:
        - in: path
          name: anomaly_notification_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyNotification'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    put:
      tags:
        - AnomalyNotifications
      operationId: AnomalyNotifications_updateNotification
      security:
        - oauth2:
            - write
      description: Update an Anomaly Notification.
      parameters:
        - in: path
          name: anomaly_notification_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateAnomalyNotification'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyNotification'
              examples:
                response:
                  value:
                    token: rprt_alrt_15da34156dca939d
                    cost_report_token: rprt_82320a9c1a608f0f
                    created_at: '2024-04-09T15:05:37Z'
                    updated_at: '2024-04-09T15:05:37Z'
                    threshold: 2
                    user_tokens:
                      - usr_dff5de2b6aecf042
                    recipient_channels:
                      - channel3
                      - channel4
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - AnomalyNotifications
      operationId: AnomalyNotifications_getByToken
      description: Return an Anomaly Notification that the current API token has access to.
      parameters:
        - in: path
          name: anomaly_notification_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnomalyNotification'
              examples:
                response:
                  value:
                    token: rprt_alrt_5af901100951705b
                    cost_report_token: rprt_0d88354748562c26
                    created_at: '2024-04-09T15:05:37Z'
                    updated_at: '2024-04-09T15:05:37Z'
                    threshold: 10
                    user_tokens:
                      - usr_e163fcb7aeb41f3b
                    recipient_channels: []
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /budgets:
    post:
      tags:
        - Budgets
      operationId: Budgets_createBudget
      security:
        - oauth2:
            - write
      description: Create a Budget.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createBudget'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Budget'
              examples:
                response:
                  value:
                    token: bdgt_67c963605b463c9a
                    name: New Budget Name
                    workspace_token: wrkspc_5272e025c2e51299
                    user_token: usr_47ea83ecb7bb8f5d
                    cost_report_token: null
                    created_at: '2024-04-12T19:33:25Z'
                    budget_alert_tokens: []
                    periods:
                      - start_at: '2024-01-01'
                        end_at: '2024-01-31'
                        amount: '100.0'
                      - start_at: '2024-02-01'
                        end_at: '2024-02-29'
                        amount: '200.0'
                      - start_at: '2024-03-01'
                        end_at: '2024-04-30'
                        amount: '300.0'
                    performance:
                      - date: April, 2024
                        actual: 0%
                        amount: '300.0'
                      - date: March, 2024
                        actual: 0%
                        amount: '300.0'
                      - date: February, 2024
                        actual: 0%
                        amount: '200.0'
                      - date: January, 2024
                        actual: 0%
                        amount: '100.0'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: UnprocessableEntity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - Budgets
      operationId: Budgets_getAll
      description: Return all Budgets.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The number of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Budgets'
              examples:
                response:
                  value:
                    links:
                      self: https://api.vantage.com/v2/budgets
                      first: https://api.vantage.com/v2/budgets?page=1
                      next: null
                      last: https://api.vantage.com/v2/budgets?page=1
                      prev: null
                    budgets:
                      - token: bdgt_f2690e3a3cf64f4e
                        name: contextually-based
                        workspace_token: wrkspc_6210a6e46e9933c6
                        user_token: usr_a4da9c294e713e24
                        cost_report_token: rprt_5309907f17010b11
                        created_at: '2024-04-12T19:33:25Z'
                        budget_alert_tokens: []
                        periods:
                          - start_at: '2024-04-01'
                            end_at: '2024-06-30'
                            amount: '10000.0'
                        performance:
                          - date: April, 2024
                            actual: '-100%'
                            amount: '10000.0'
  /budgets/{budget_token}:
    delete:
      tags:
        - Budgets
      operationId: Budgets_deleteBudget
      security:
        - oauth2:
            - write
      description: Delete a Budget.
      parameters:
        - in: path
          name: budget_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Budget'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    put:
      tags:
        - Budgets
      operationId: Budgets_updateBudget
      security:
        - oauth2:
            - write
      description: Update a Budget.
      parameters:
        - in: path
          name: budget_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateBudget'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Budget'
              examples:
                response:
                  value:
                    token: bdgt_056887ad3d9c9710
                    name: New Name New Budget Who Dis
                    workspace_token: wrkspc_85a607a626ba9b39
                    user_token: usr_5bd274f26b777577
                    cost_report_token: rprt_4a53de75c432dd44
                    created_at: '2024-04-12T19:33:25Z'
                    budget_alert_tokens: []
                    periods:
                      - start_at: '2023-01-01'
                        end_at: '2023-01-31'
                        amount: '234.0'
                      - start_at: '2024-01-01'
                        end_at: '2024-01-31'
                        amount: '123.0'
                      - start_at: '2024-04-01'
                        end_at: '2024-06-30'
                        amount: '10000.0'
                    performance:
                      - date: April, 2024
                        actual: '-100%'
                        amount: '10000.0'
                      - null
                      - null
                      - date: January, 2024
                        actual: '-100%'
                        amount: '123.0'
                      - null
                      - null
                      - null
                      - null
                      - null
                      - null
                      - null
                      - null
                      - null
                      - null
                      - null
                      - date: January, 2023
                        actual: 1224%
                        amount: '234.0'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - Budgets
      operationId: Budgets_getBudget
      description: Return a Budget.
      parameters:
        - in: path
          name: budget_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Budget'
              examples:
                response:
                  value:
                    token: bdgt_46df14a770ad8e38
                    name: Reverse-engineered
                    workspace_token: wrkspc_cf284d188c114099
                    user_token: usr_cd90de17f3dddd1b
                    cost_report_token: rprt_08a5f7ad5ad7bcd6
                    created_at: '2024-04-12T19:33:25Z'
                    budget_alert_tokens: []
                    periods:
                      - start_at: '2024-04-01'
                        end_at: '2024-06-30'
                        amount: '10000.0'
                    performance:
                      - date: April, 2024
                        actual: '-100%'
                        amount: '10000.0'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /budget_alerts:
    post:
      tags:
        - BudgetAlerts
      operationId: BudgetAlerts_createAlert
      security:
        - oauth2:
            - write
      description: Create a Budget Alert.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BudgetAlertsCreateAlertRequest'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BudgetAlert'
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - BudgetAlerts
      operationId: BudgetAlerts_listAll
      description: Return all BudgetAlerts.
      parameters:
        - description: The page of results to return.
          in: query
          name: page
          required: false
          schema:
            type: integer
            format: int32
        - description: The number of results to return. The maximum is 1000.
          in: query
          name: limit
          required: false
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BudgetAlerts'
  /budget_alerts/{budget_alert_token}:
    delete:
      tags:
        - BudgetAlerts
      operationId: BudgetAlerts_deleteAlert
      security:
        - oauth2:
            - write
      description: Delete a BudgetAlert.
      parameters:
        - in: path
          name: budget_alert_token
          required: true
          schema:
            type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BudgetAlert'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    put:
      tags:
        - BudgetAlerts
      operationId: BudgetAlerts_updateExistingAlert
      security:
        - oauth2:
            - write
      description: Updates an existing BudgetAlert.
      parameters:
        - in: path
          name: budget_alert_token
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BudgetAlertsUpdateExistingAlertRequest'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BudgetAlert'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
        - BudgetAlerts
      operationId: BudgetAlerts_getByToken
      description: Return a BudgetAlert.
      parameters:
        - in: path
          name: budget_alert_token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BudgetAlert'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
  /ping:
    get:
      tags:
        - Ping
      operationId: Ping_healthCheck
      description: >-
        This is a health check endpoint that can be used to determine Vantage
        API healthiness. It will return 200 if everything is running smoothly.
      responses:
        '200':
          description: >-
            This is a health check endpoint that can be used to determine
            Vantage API healthiness. It will return 200 if everything is running
            smoothly.
components:
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://console.vantage.sh/account/profile
          scopes:
            read: Grants read access
            write: Grants write access
  schemas:
    Workspaces:
      description: Workspaces model
      type: object
      properties:
        links:
          type: object
        workspaces:
          type: array
          items:
            $ref: '#/components/schemas/Workspace'
    Workspace:
      description: Workspace model
      type: object
      properties:
        token:
          type: string
        name:
          description: The name of the Workspace.
          type: string
          example: Acme Corp.
    Errors:
      description: Errors model
      type: object
      properties:
        links:
          type: object
        errors:
          type: array
          items:
            type: string
    createFolder:
      description: Create a Folder for CostReports.
      type: object
      properties:
        title:
          description: The title of the Folder.
          type: string
        parent_folder_token:
          description: The token of the parent Folder.
          type: string
        saved_filter_tokens:
          description: >-
            The tokens of the SavedFilters to apply to any Cost Report contained
            within the Folder.
          type: array
          items:
            type: string
        workspace_token:
          description: >-
            The token of the Workspace to add the Folder to. Ignored if
            'parent_folder_token' is set. Required if the API token is
            associated with multiple Workspaces.
          type: string
      required:
        - title
    Folder:
      description: Folder model
      type: object
      properties:
        title:
          description: The title of the Folder.
          type: string
          example: Platform Team Reports
        token:
          type: string
        parent_folder_token:
          description: The token for the parent Folder, if any.
          type: string
        saved_filter_tokens:
          description: The tokens for the SavedFilters assigned to the Folder.
          type: array
          items:
            type: string
        created_at:
          description: >-
            The date and time, in UTC, the Folder was created. ISO 8601
            Formatted.
          type: string
          example: '2023-08-04T00:00:00Z'
        updated_at:
          description: >-
            The date and time, in UTC, the Folder was last updated at. ISO 8601
            Formatted.
          type: string
          example: '2023-08-04T00:00:00Z'
        workspace_token:
          description: The token for the Workspace the Folder is a part of.
          type: string
    Folders:
      description: Folders model
      type: object
      properties:
        links:
          type: object
        folders:
          type: array
          items:
            $ref: '#/components/schemas/Folder'
    updateFolder:
      description: Update a Folder for CostReports.
      type: object
      properties:
        title:
          description: The title of the Folder.
          type: string
        parent_folder_token:
          description: The token of the parent Folder.
          type: string
        saved_filter_tokens:
          description: >-
            The tokens of the SavedFilters to apply to any Cost Report contained
            within the Folder.
          type: array
          items:
            type: string
    createSavedFilter:
      description: Create a SavedFilter for CostReports.
      type: object
      properties:
        title:
          description: The title of the SavedFilter.
          type: string
        workspace_token:
          description: >-
            The Workspace to associate the SavedFilter with. Required if the API
            token is associated with multiple Workspaces.
          type: string
        filter:
          description: >-
            The filter query language to apply to the SavedFilter, which
            subsequently gets applied to a CostReport. Additional documentation
            available at https://docs.vantage.sh/vql.
          type: string
      required:
        - title
    SavedFilter:
      description: SavedFilter model
      type: object
      properties:
        title:
          description: The title of the SavedFilter.
          type: string
          example: Platform Team Reports
        token:
          type: string
        cost_report_tokens:
          description: The tokens for any CostReports the SavedFilter is applied to.
          type: array
          items:
            type: string
            example:
              - rprt_abcd1234
              - rprt_efgh5678
        filter:
          description: >-
            The SavedFilter's filter, applied to any relevant CostReports.
            Additional documentation available at https://docs.vantage.sh/vql.
          type: string
          example: costs.provider = 'azure'
        created_at:
          description: >-
            The date and time, in UTC, the report was created. ISO 8601
            Formatted.
          type: string
          example: '2023-08-04T00:00:00Z'
        created_by:
          description: The User who created the SavedFilter.
          type: string
        workspace_token:
          description: The token for the Workspace the SavedFilter is a part of.
          type: string
    SavedFilters:
      description: SavedFilters model
      type: object
      properties:
        links:
          type: object
        saved_filters:
          type: array
          items:
            $ref: '#/components/schemas/SavedFilter'
    updateSavedFilter:
      description: Update a SavedFilter for CostReports.
      type: object
      properties:
        title:
          description: The title of the SavedFilter.
          type: string
        filter:
          description: >-
            The filter query language to apply to the SavedFilter, which
            subsequently gets applied to a CostReport. Additional documentation
            available at https://docs.vantage.sh/vql.
          type: string
    createCostReport:
      description: Create a CostReport.
      type: object
      properties:
        title:
          description: The title of the CostReport.
          type: string
        workspace_token:
          description: >-
            The token of the Workspace to add the Cost Report to. Ignored if
            'folder_token' is set. Required if the API token is associated with
            multiple Workspaces.
          type: string
        groupings:
          description: >-
            Grouping values for aggregating costs on the report. Valid
            groupings: account_id, billing_account_id, charge_type,
            cost_category, cost_subcategory, provider, region, resource_id,
            service, tagged, tag:<tag_value>. If providing multiple groupings,
            join as comma separated values: groupings=provider,service,region
          type: string
        filter:
          description: >-
            The filter query language to apply to the CostReport. Additional
            documentation available at https://docs.vantage.sh/vql.
          type: string
        saved_filter_tokens:
          description: The tokens of the SavedFilters to apply to the CostReport.
          type: array
          items:
            type: string
        business_metric_tokens_with_metadata:
          description: >-
            The tokens for any BusinessMetrics to attach to the CostReport, and
            the unit scale.
          type: array
          items:
            type: object
            properties:
              business_metric_token:
                description: The token of the BusinessMetric to attach to the CostReport.
                type: string
              unit_scale:
                description: >-
                  Determines the scale of the BusinessMetric's values within the
                  CostReport.
                type: string
                enum:
                  - per_unit
                  - per_hundred
                  - per_thousand
                  - per_million
                  - per_billion
                default: per_unit
            required:
              - business_metric_token
        folder_token:
          description: >-
            The token of the Folder to add the CostReport to. Determines the
            Workspace the report is assigned to.
          type: string
        settings:
          description: Report settings.
          type: object
          properties:
            include_credits:
              description: Report will include credits.
              type: boolean
              default: false
            include_refunds:
              description: Report will include refunds.
              type: boolean
              default: false
            include_discounts:
              description: Report will include discounts.
              type: boolean
              default: true
            include_tax:
              description: Report will include tax.
              type: boolean
              default: true
            amortize:
              description: Report will amortize.
              type: boolean
              default: true
            unallocated:
              description: Report will show unallocated costs.
              type: boolean
              default: false
      required:
        - title
    CostReport:
      description: CostReport model
      type: object
      properties:
        title:
          description: The title of the CostReport.
          type: string
          example: Production Environment
        token:
          type: string
        folder_token:
          description: The token for the Folder the CostReport is a part of.
          type: string
        saved_filter_tokens:
          description: The tokens for the SavedFilters assigned to the CostReport.
          type: array
          items:
            type: string
        business_metric_tokens_with_metadata:
          description: >-
            The tokens for the BusinessMetrics assigned to the CostReport, and
            the unit scale.
          type: array
          items:
            $ref: '#/components/schemas/AttachedBusinessMetricForCostReport'
        filter:
          description: >-
            The filter applied to the CostReport. Additional documentation
            available at https://docs.vantage.sh/vql.
          type: string
        groupings:
          description: The grouping aggregations applied to the filtered data.
          type: string
          example: provider, service
        settings:
          description: Report settings.
          type: object
          properties:
            include_credits:
              description: Report will include credits.
              type: boolean
              default: false
            include_refunds:
              description: Report will include refunds.
              type: boolean
              default: false
            include_discounts:
              description: Report will include discounts.
              type: boolean
              default: true
            include_tax:
              description: Report will include tax.
              type: boolean
              default: true
            amortize:
              description: Report will amortize.
              type: boolean
              default: true
            unallocated:
              description: Report will show unallocated costs.
              type: boolean
              default: false
        created_at:
          description: >-
            The date and time, in UTC, the report was created. ISO 8601
            Formatted.
          type: string
          example: '2021-07-09T00:00:00Z'
        workspace_token:
          description: The token for the Workspace the CostReport is a part of.
          type: string
    AttachedBusinessMetricForCostReport:
      type: object
      properties:
        business_metric_token:
          description: The token of the BusinessMetric that's attached to the CostReport.
          type: string
          example: bsnss_mtrc_1234
        unit_scale:
          description: >-
            Determines the scale of the BusinessMetric's values within a
            particular CostReport.
          type: string
          example: per_hundred
          enum:
            - per_unit
            - per_hundred
            - per_thousand
            - per_million
            - per_billion
    CostReports:
      description: CostReports model
      type: object
      properties:
        links:
          type: object
        cost_reports:
          type: array
          items:
            $ref: '#/components/schemas/CostReport'
    updateCostReport:
      description: Update a CostReport.
      type: object
      properties:
        title:
          description: The title of the CostReport.
          type: string
        groupings:
          description: >-
            Grouping values for aggregating costs on the report. Valid
            groupings: account_id, billing_account_id, charge_type,
            cost_category, cost_subcategory, provider, region, resource_id,
            service, tagged, tag:<tag_value>. If providing multiple groupings,
            join as comma separated values: groupings=provider,service,region
          type: string
        filter:
          description: >-
            The filter query language to apply to the CostReport. Additional
            documentation available at https://docs.vantage.sh/vql.
          type: string
        saved_filter_tokens:
          description: The tokens of the SavedFilters to apply to the CostReport.
          type: array
          items:
            type: string
        business_metric_tokens_with_metadata:
          description: >-
            The tokens for any BusinessMetrics to attach to the CostReport, and
            the unit scale.
          type: array
          items:
            type: object
            properties:
              business_metric_token:
                description: The token of the BusinessMetric to attach to the CostReport.
                type: string
              unit_scale:
                description: >-
                  Determines the scale of the BusinessMetric's values within the
                  CostReport.
                type: string
                enum:
                  - per_unit
                  - per_hundred
                  - per_thousand
                  - per_million
                  - per_billion
                default: per_unit
            required:
              - business_metric_token
        folder_token:
          description: >-
            The token of the Folder to add the CostReport to. Determines the
            Workspace the report is assigned to.
          type: string
        settings:
          description: Report settings.
          type: object
          properties:
            include_credits:
              description: Report will include credits.
              type: boolean
            include_refunds:
              description: Report will include refunds.
              type: boolean
            include_discounts:
              description: Report will include discounts.
              type: boolean
            include_tax:
              description: Report will include tax.
              type: boolean
            amortize:
              description: Report will amortize.
              type: boolean
            unallocated:
              description: Report will show unallocated costs.
              type: boolean
    createSegment:
      description: Create a Segment.
      type: object
      properties:
        title:
          description: The title of the Segment.
          type: string
        description:
          description: The description of the Segment.
          type: string
        priority:
          description: The priority of the Segment.
          type: integer
          format: int32
        track_unallocated:
          description: >-
            Track Unallocated Costs which are not assigned to any of the created
            Segments.
          type: boolean
          default: false
        report_settings:
          description: Report settings configurable on top-level Segments.
          type: object
          properties:
            include_credits:
              description: Reports created under this Segment will include credits.
              type: boolean
            include_refunds:
              description: Reports created under this Segment will include refunds.
              type: boolean
            include_discounts:
              description: Reports created under this Segment will include discounts.
              type: boolean
            include_tax:
              description: Reports created under this Segment will include tax.
              type: boolean
            amortize:
              description: Reports created under this Segment will amortize.
              type: boolean
        workspace_token:
          description: >-
            The token of the Workspace to add the Segment to. Ignored if
            'segment_token' is set. Required if the API token is associated with
            multiple Workspaces.
          type: string
        filter:
          description: >-
            The filter query language to apply to the Segment. Additional
            documentation available at https://docs.vantage.sh/vql.
          type: string
        parent_segment_token:
          description: >-
            The token of the parent Segment this new Segment belongs to.
            Determines the Workspace the segment is assigned to.
          type: string
      required:
        - title
    Segment:
      description: Segment model
      type: object
      properties:
        title:
          description: The title of the Segment.
          type: string
          example: OPEX
        description:
          description: The description of the Segment.
          type: string
          example: Operating expenses
        token:
          type: string
        parent_segment_token:
          description: The token of the parent Segment of this Segment.
          type: string
        track_unallocated:
          description: >-
            Track Unallocated Costs which are not assigned to any of the created
            Segments.
          type: boolean
          example: false
        report_settings:
          description: Report settings configurable on top-level Segments.
          type: object
          properties:
            include_credits:
              type: boolean
            include_refunds:
              type: boolean
            include_discounts:
              type: boolean
            include_tax:
              type: boolean
            amortize:
              type: boolean
        priority:
          description: >-
            Costs are assigned in priority order across all Segments with
            assigned filters.
          type: integer
          format: int32
          example: 100
        filter:
          description: >-
            The filter applied to the Segment. Additional documentation
            available at https://docs.vantage.sh/vql.
          type: string
        created_at:
          description: >-
            The date and time, in UTC, the Segment was created. ISO 8601
            Formatted.
          type: string
          example: '2021-07-09T00:00:00Z'
        workspace_token:
          description: The token for the Workspace the Segment is a part of.
          type: string
    Segments:
      description: Segments model
      type: object
      properties:
        links:
          type: object
        segments:
          type: array
          items:
            $ref: '#/components/schemas/Segment'
    updateSegment:
      description: Update a Segment.
      type: object
      properties:
        title:
          description: The title of the Segment.
          type: string
        description:
          description: The description of the Segment.
          type: string
        priority:
          description: The priority of the Segment.
          type: integer
          format: int32
        track_unallocated:
          description: >-
            Track Unallocated Costs which are not assigned to any of the created
            Segments.
          type: boolean
          default: false
        report_settings:
          description: Report settings configurable on top-level Segments.
          type: object
          properties:
            include_credits:
              description: Reports created under this Segment will include credits.
              type: boolean
            include_refunds:
              description: Reports created under this Segment will include refunds.
              type: boolean
            include_discounts:
              description: Reports created under this Segment will include discounts.
              type: boolean
            include_tax:
              description: Reports created under this Segment will include tax.
              type: boolean
            amortize:
              description: Reports created under this Segment will amortize.
              type: boolean
        filter:
          description: >-
            The filter query language to apply to the Segment. Additional
            documentation available at https://docs.vantage.sh/vql.
          type: string
        parent_segment_token:
          description: >-
            The token of the parent Segment this new Segment belongs to.
            Determines the Workspace the segment is assigned to.
          type: string
    createDashboard:
      description: Create a Dashboard.
      type: object
      properties:
        title:
          description: The title of the Dashboard.
          type: string
        widget_tokens:
          description: >-
            The tokens of the widgets to add to the Dashboard. Currently only
            supports CostReport tokens.
          type: array
          items:
            type: string
        saved_filter_tokens:
          description: The tokens of the Saved Filters used in the Dashboard.
          type: array
          items:
            type: string
        date_bin:
          description: Determines how to group costs in the Dashboard.
          type: string
          enum:
            - cumulative
            - day
            - week
            - month
        date_interval:
          description: >-
            Determines the date range in the Dashboard. Incompatible with
            'start_date' and 'end_date' parameters.
          type: string
          enum:
            - this_month
            - last_7_days
            - last_30_days
            - last_month
            - last_3_months
            - last_6_months
            - custom
            - last_12_months
            - last_24_months
            - last_36_months
            - next_month
            - next_3_months
            - next_6_months
            - next_12_months
        start_date:
          description: >-
            The start date for the date range for costs in the Dashboard. ISO
            8601 Formatted. Incompatible with 'date_interval' parameter.
          type: string
        end_date:
          description: >-
            The end date for the date range for costs in the Dashboard. ISO 8601
            Formatted. Incompatible with 'date_interval' parameter.
          type: string
        workspace_token:
          description: >-
            The token of the Workspace to add the Dashboard to. Required if the
            API token is associated with multiple Workspaces.
          type: string
      required:
        - title
        - end_date
    Dashboard:
      description: Dashboard model
      type: object
      properties:
        title:
          description: The title of the Dashboard.
          type: string
          example: AWS Dashboard
        token:
          type: string
          example: dshbrd_abcd1234567890
        widget_tokens:
          description: >-
            The tokens of the widgets displayed in the Dashboard. Currently only
            supports CostReport tokens.
          type: array
          items:
            type: string
        saved_filter_tokens:
          description: The tokens of the Saved Filters used in the Dashboard.
          type: array
          items:
            type: string
        date_bin:
          description: Determines how to group costs in the Dashboard.
          type: string
          enum:
            - cumulative
            - day
            - week
            - month
        date_interval:
          description: >-
            Determines the date range in the Dashboard. Guaranteed to be set to
            'custom' if 'start_date' and 'end_date' are set.
          type: string
          enum:
            - this_month
            - last_7_days
            - last_30_days
            - last_month
            - last_3_months
            - last_6_months
            - custom
            - last_12_months
            - last_24_months
            - last_36_months
            - next_month
            - next_3_months
            - next_6_months
            - next_12_months
        start_date:
          description: >-
            The start date for the date range for CostReports in the Dashboard.
            ISO 8601 Formatted. Overwrites 'date_interval' if set.
          type: string
          example: '2023-08-04'
        end_date:
          description: >-
            The end date for the date range for CostReports in the Dashboard.
            ISO 8601 Formatted. Overwrites 'date_interval' if set.
          type: string
          example: '2023-09-04'
        created_at:
          description: >-
            The date and time, in UTC, the Dashboard was created. ISO 8601
            Formatted.
          type: string
          example: '2023-08-04T00:00:00Z'
        updated_at:
          description: >-
            The date and time, in UTC, the Dashboard was created. ISO 8601
            Formatted.
          type: string
          example: '2023-08-04T00:00:00Z'
        workspace_token:
          description: The token for the Workspace the Dashboard is a part of.
          type: string
          example: wrkspc_abcd1234567890
    Dashboards:
      description: Dashboards model
      type: object
      properties:
        links:
          type: object
        dashboards:
          type: array
          items:
            $ref: '#/components/schemas/Dashboard'
    updateDashboard:
      description: Update a Dashboard.
      type: object
      properties:
        title:
          description: The title of the Dashboard.
          type: string
        widget_tokens:
          description: >-
            The tokens of the widgets to add to the Dashboard. Currently only
            supports CostReport tokens.
          type: array
          items:
            type: string
        saved_filter_tokens:
          description: The tokens of the Saved Filters used in the Dashboard.
          type: array
          items:
            type: string
        date_bin:
          description: Determines how to group costs in the Dashboard.
          type: string
          enum:
            - cumulative
            - day
            - week
            - month
        date_interval:
          description: >-
            Determines the date range in the Dashboard. Incompatible with
            'start_date' and 'end_date' parameters.
          type: string
          enum:
            - this_month
            - last_7_days
            - last_30_days
            - last_month
            - last_3_months
            - last_6_months
            - custom
            - last_12_months
            - last_24_months
            - last_36_months
            - next_month
            - next_3_months
            - next_6_months
            - next_12_months
        start_date:
          description: >-
            The start date for the date range for costs in the Dashboard. ISO
            8601 Formatted. Incompatible with 'date_interval' parameter.
          type: string
        end_date:
          description: >-
            The end date for the date range for costs in the Dashboard. ISO 8601
            Formatted. Incompatible with 'date_interval' parameter.
          type: string
      required:
        - end_date
    Costs:
      description: Costs model
      type: object
      properties:
        links:
          type: object
        total_cost:
          description: >-
            The sum of all costs for the CostReport for the requested period,
            rounded to 2 decimal places, alongside the ISO 4217 currency code.
          type: string
        costs:
          type: array
          items:
            $ref: '#/components/schemas/Cost'
    Cost:
      type: object
      properties:
        tags:
          description: The tag pairs attached to the cost that was incurred.
          type: array
          items:
            type: string
            example:
              - environment:production
              - aws:ecs:serviceName:frontend
        links:
          type: object
        accrued_at:
          description: The date the cost was accrued. ISO 8601 Formatted.
          type: string
          example: 2023-09-05+00:00
        amount:
          description: The amount of the cost.
          type: string
          example: '4.25'
        currency:
          description: The currency of the cost.
          type: string
          example: USD
        provider:
          description: The cost provider which incurred the cost.
          type: string
          example: aws
          enum:
            - aws
            - azure
            - gcp
            - snowflake
            - databricks
            - mongo
            - datadog
            - fastly
            - new_relic
            - opencost
            - open_ai
            - oracle
            - confluent
            - planetscale
            - coralogix
            - kubernetes
        billing_account_id:
          description: The cost provider's billing account id that incurred the cost.
          type: string
          example: '9109237192'
        account_id:
          description: The cost provider's account id that incurred the cost.
          type: string
          example: '9109237192'
        service:
          description: The service which incurred the cost.
          type: string
          example: Amazon Elastic Compute Cloud - Compute
        region:
          description: The region which incurred the cost.
          type: string
          example: us-east-1
        resource_id:
          description: The resource id which incurred the cost.
          type: string
          example: arn:aws:ec2:us-east-1:123456789012:instance/i-1234567890abcdef0
        tag:
          description: |-
            The tag attached to the cost that was incurred.
            DEPRECATED: does not support multiple tags.
          type: string
          example: production
        cost_category:
          description: The category for the cost.
          type: string
          example: Data Transfer
        cost_subcategory:
          description: The subcategory for the cost.
          type: string
          example: DataTransfer-Regional-Bytes
    createTeam:
      description: Create a new Team.
      type: object
      properties:
        description:
          description: The description of the Team.
          type: string
        name:
          description: The name of the Team.
          type: string
        workspace_tokens:
          description: The Workspace tokens to associate to the Team.
          type: array
          items:
            type: string
        user_tokens:
          description: The User tokens to associate to the Team.
          type: array
          items:
            type: string
        user_emails:
          description: The User emails to associate to the Team.
          type: array
          items:
            type: string
        role:
          description: >-
            The role to assign to the provided Users. Defaults to 'editor' which
            has editor permissions.
          type: string
          enum:
            - owner
            - editor
            - viewer
      required:
        - name
    Team:
      description: Team model
      type: object
      properties:
        description:
          description: The description of the Team.
          type: string
          example: The Team that saves costs
        token:
          type: string
        name:
          description: The name of the Team.
          type: string
          example: Cost Savers
        workspace_tokens:
          description: The tokens for any Workspaces that the Team belongs to
          type: array
          items:
            type: string
            example:
              - wrkspc_abcd1234
              - wrkspc_efgh5678
        user_emails:
          description: The email addresses for Users that belong to the Team
          type: array
          items:
            type: string
            example:
              - wileycoyote@acme.com
              - roadrunner@acme.com
        user_tokens:
          description: The tokens for Users that belong to the Team
          type: array
          items:
            type: string
            example:
              - usr_abcd1234
              - usr_efgh5678
    Teams:
      description: Teams model
      type: object
      properties:
        links:
          type: object
        teams:
          type: array
          items:
            $ref: '#/components/schemas/Team'
    updateTeam:
      description: Update a Team.
      type: object
      properties:
        description:
          description: The description of the Team.
          type: string
        name:
          description: The name of the Team.
          type: string
        workspace_tokens:
          description: The Workspace tokens to associate to the Team.
          type: array
          items:
            type: string
        user_tokens:
          description: The User tokens to associate to the Team.
          type: array
          items:
            type: string
        user_emails:
          description: The User emails to associate to the Team.
          type: array
          items:
            type: string
        role:
          description: >-
            The role to assign to the provided Users. Defaults to 'editor' which
            has editor permissions.
          type: string
          enum:
            - owner
            - editor
            - viewer
    createAccessGrant:
      description: Create an Access Grant.
      type: object
      properties:
        resource_token:
          description: The token of the resource for which you are granting access.
          type: string
        team_token:
          description: The token of the Team you want to grant access to.
          type: string
        access:
          description: The access level you want to grant. Defaults to 'allowed'.
          type: string
          enum:
            - denied
            - allowed
      required:
        - resource_token
        - team_token
    AccessGrant:
      description: AccessGrant model
      type: object
      properties:
        token:
          type: string
        resource_token:
          description: The token for any resource the AccessGrant is applied to.
          type: string
          example: rprt_abcd1234
        access:
          description: The access status of the AccessGrant.
          type: string
        team_token:
          description: The Team token for which an AccessGrant is applied to.
          type: string
        created_at:
          description: >-
            The date and time, in UTC, the AccessGrant was created. ISO 8601
            Formatted.
          type: string
          example: '2023-08-04T00:00:00Z'
        created_by:
          description: The token for the User who created the AccessGrant.
          type: string
    AccessGrants:
      description: AccessGrants model
      type: object
      properties:
        links:
          type: object
        access_grants:
          type: array
          items:
            $ref: '#/components/schemas/AccessGrant'
    updateAccessGrant:
      description: Update an AccessGrant.
      type: object
      properties:
        access:
          description: Allowed or denied access to resource.
          type: string
          enum:
            - denied
            - allowed
      required:
        - access
    createReportNotification:
      description: Create a ReportNotification.
      type: object
      properties:
        title:
          description: The title of the ReportNotification.
          type: string
        cost_report_token:
          description: The CostReport token.
          type: string
        workspace_token:
          description: >-
            The token of the Workspace to add the ReportNotification to.
            Required if the API token is associated with multiple Workspaces.
          type: string
        user_tokens:
          description: The Users that receive the notification.
          type: array
          items:
            type: string
        recipient_channels:
          description: The Slack or Microsoft Teams channels that receive the notification.
          type: array
          items:
            type: string
        frequency:
          description: >-
            The frequency the ReportNotification is sent. Possible values:
            daily, weekly, monthly.
          type: string
        change:
          description: >-
            The type of change the ReportNotification is tracking. Possible
            values: percentage, dollars.
          type: string
      required:
        - title
        - cost_report_token
        - frequency
        - change
    ReportNotification:
      description: ReportNotification model
      type: object
      properties:
        title:
          description: The title of the ReportNotification.
          type: string
          example: Acme Report Notification
        token:
          type: string
        cost_report_token:
          description: The token for a CostReport the ReportNotification is applied to.
          type: string
          example: rprt_abcd1234
        user_tokens:
          description: The Users that receive the notification.
          type: array
          items:
            type: string
            example:
              - usr_abcd1234
              - usr_efgh5678
        recipient_channels:
          description: The Slack or Microsoft Teams channels that receive the notification.
          type: array
          items:
            type: string
            example:
              - '#notifications-channel'
        frequency:
          description: The frequency the ReportNotification is sent.
          type: string
          example: weekly
          enum:
            - daily
            - weekly
            - monthly
        change:
          description: The type of change the ReportNotification is tracking.
          type: string
          example: percentage
          enum:
            - percentage
            - dollars
    ReportNotifications:
      description: ReportNotifications model
      type: object
      properties:
        links:
          type: object
        report_notifications:
          type: array
          items:
            $ref: '#/components/schemas/ReportNotification'
    updateReportNotification:
      description: Update a ReportNotification.
      type: object
      properties:
        title:
          description: The title of the ReportNotification.
          type: string
        cost_report_token:
          description: The CostReport token.
          type: string
        user_tokens:
          description: The Users that receive the notification.
          type: array
          items:
            type: string
        recipient_channels:
          description: The Slack or Microsoft Teams channels that receive the notification.
          type: array
          items:
            type: string
        frequency:
          description: >-
            The frequency the ReportNotification is sent. Possible values:
            daily, weekly, monthly.
          type: string
        change:
          description: >-
            The type of change the ReportNotification is tracking. Possible
            values: percentage, dollars.
          type: string
    Users:
      description: Users model
      type: object
      properties:
        links:
          type: object
        users:
          type: array
          items:
            $ref: '#/components/schemas/User'
    User:
      description: User model
      type: object
      properties:
        token:
          type: string
        name:
          description: The name of the User.
          type: string
          example: John Doe
        email:
          description: The email of the User.
          type: string
          example: john_doe@acme.com
        role:
          description: The role of the User.
          type: string
          example: Admin
    createBusinessMetric:
      description: Create a new BusinessMetric.
      type: object
      properties:
        title:
          description: The title of the BusinessMetrics.
          type: string
        cost_report_tokens_with_metadata:
          description: >-
            The tokens for any CostReports that use the BusinessMetric, and the
            unit scale.
          type: array
          items:
            type: object
            properties:
              cost_report_token:
                description: The token of the CostReport the BusinessMetric is attached to.
                type: string
              unit_scale:
                description: >-
                  Determines the scale of the BusinessMetric's values within the
                  CostReport.
                type: string
                enum:
                  - per_unit
                  - per_hundred
                  - per_thousand
                  - per_million
                  - per_billion
                default: per_unit
            required:
              - cost_report_token
        values:
          description: The dates and amounts for the BusinessMetric.
          type: array
          items:
            type: object
            properties:
              date:
                type: string
                format: date-time
              amount:
                type: number
                format: double
            required:
              - date
              - amount
      required:
        - title
    BusinessMetric:
      description: BusinessMetric model
      type: object
      properties:
        title:
          description: The title of the BusinessMetric.
          type: string
          example: Total Revenue
        token:
          description: The token of the BusinessMetric.
          type: string
          example: bsnss_mtrc_1234
        created_by_token:
          description: The token of the User who created the BusinessMetric.
          type: string
          example: usr_1234
        cost_report_tokens_with_metadata:
          description: >-
            The tokens for any CostReports that use the BusinessMetric, and the
            unit scale.
          type: array
          items:
            $ref: '#/components/schemas/AttachedCostReportForBusinessMetric'
        values:
          description: The dates and amounts for the BusinessMetric
          type: array
          items:
            $ref: '#/components/schemas/BusinessMetricValue'
    AttachedCostReportForBusinessMetric:
      type: object
      properties:
        cost_report_token:
          description: The token of the CostReport the BusinessMetric is attached to.
          type: string
          example: rprt_1234
        unit_scale:
          description: >-
            Determines the scale of the BusinessMetric's values within a
            particular CostReport.
          type: string
          example: per_hundred
          enum:
            - per_unit
            - per_hundred
            - per_thousand
            - per_million
            - per_billion
    BusinessMetricValue:
      type: object
      properties:
        date:
          description: The date of the Business Metric Value. ISO 8601 formatted.
          type: string
          example: 2024-03-01+00:00
        amount:
          description: >-
            The amount of the Business Metric Value as a string to ensure
            precision.
          type: string
          example: '100.00'
    BusinessMetrics:
      description: BusinessMetrics model
      type: object
      properties:
        business_metrics:
          type: array
          items:
            $ref: '#/components/schemas/BusinessMetric'
    updateBusinessMetric:
      description: Updates an existing BusinessMetric.
      type: object
      properties:
        title:
          description: The title of the BusinessMetric.
          type: string
        cost_report_tokens_with_metadata:
          description: >-
            The tokens for any CostReports that use the BusinessMetric, and the
            unit scale.
          type: array
          items:
            type: object
            properties:
              cost_report_token:
                description: The token of the CostReport the BusinessMetric is attached to.
                type: string
              unit_scale:
                description: >-
                  Determines the scale of the BusinessMetric's values within the
                  CostReport.
                type: string
                enum:
                  - per_unit
                  - per_hundred
                  - per_thousand
                  - per_million
                  - per_billion
                default: per_unit
            required:
              - cost_report_token
        values:
          description: The dates and amounts for the BusinessMetric.
          type: array
          items:
            type: object
            properties:
              date:
                type: string
                format: date-time
              amount:
                type: number
                format: double
            required:
              - date
              - amount
    Products:
      description: Products model
      type: object
      properties:
        links:
          type: object
        products:
          type: array
          items:
            $ref: '#/components/schemas/Product'
    Product:
      description: Product model
      type: object
      properties:
        id:
          type: string
        category:
          description: The category of the cloud product
          type: string
          example: compute
        name:
          description: The common name of the product.
          type: string
          example: EC2
        service_id:
          description: A unique slug for the service the product belongs to.
          type: string
          example: aws-ec2
        provider_id:
          description: A unique slug for the provider the product belongs to.
          type: string
          example: aws
        details:
          description: An object of metadata about the product.
          type: object
          example:
            gpu: 0
            name: M5 General Purpose 16xlarge
            vcpu: 64
            memory: 256
            clock_speed_ghz: 3.1
            physical_processor_description: Intel Xeon Platinum 8175 (Skylake)
            network_performance_description: 20 Gigabit
    Prices:
      description: Prices model
      type: object
      properties:
        links:
          type: object
        prices:
          type: array
          items:
            $ref: '#/components/schemas/Price'
    Price:
      description: Price model
      type: object
      properties:
        id:
          type: string
        unit:
          description: The unit in which the amount is billed.
          type: string
          example: hour
        region:
          description: The region the price is specific to.
          type: string
          example: us-east-1
        rate_type:
          description: >-
            The part of the product the price applies to. (compute, transfer,
            etc..)
          type: string
          example: compute
        currency:
          description: The currency of the amount.
          type: string
          example: USD
        amount:
          description: The amount of money this specific product price costs.
          type: number
          example: 1.324
        details:
          description: Service specific metadata.
          type: object
          example:
            platform: linux-enterprise
            lifecycle: on-demand
    ResourceReports:
      description: ResourceReports model
      type: object
      properties:
        links:
          type: object
        resource_reports:
          type: array
          items:
            $ref: '#/components/schemas/ResourceReport'
    ResourceReport:
      description: ResourceReport model
      type: object
      properties:
        title:
          description: The title of the ResourceReport.
          type: string
          example: Acme123 Active Resources
        token:
          type: string
        default:
          description: Indicates whether the ResourceReport is the default report.
          type: boolean
        created_at:
          description: >-
            The date and time, in UTC, the report was created. ISO 8601
            Formatted.
          type: string
          example: '2024-03-19T00:00:00Z'
        workspace_token:
          description: The token for the Workspace the ResourceReport is a part of.
          type: string
        segment_token:
          description: The token for the Segment the ResourceReport is a part of.
          type: string
        user_token:
          description: The token for the User who created this ResourceReport.
          type: string
    FinancialCommitmentReports:
      description: FinancialCommitmentReports model
      type: object
      properties:
        links:
          type: object
        financial_commitment_reports:
          type: array
          items:
            $ref: '#/components/schemas/FinancialCommitmentReport'
    FinancialCommitmentReport:
      description: FinancialCommitmentReport model
      type: object
      properties:
        title:
          description: The title of the FinancialCommitmentReport.
          type: string
          example: Acme123 Financial Commitment Report
        token:
          type: string
        default:
          description: >-
            Indicates whether the FinancialCommitmentReport is the default
            report.
          type: boolean
        created_at:
          description: >-
            The date and time, in UTC, the report was created. ISO 8601
            Formatted.
          type: string
          example: '2024-03-19T00:00:00Z'
        workspace_token:
          description: >-
            The token for the Workspace the FinancialCommitmentReport is a part
            of.
          type: string
        user_token:
          description: The token for the User who created this FinancialCommitmentReport.
          type: string
        start_date:
          description: >-
            The start date for the FinancialCommitmentReport. Only set for
            custom date ranges. ISO 8601 Formatted.
          type: string
          example: '2024-03-01'
        end_date:
          description: >-
            The end date for the FinancialCommitmentReport. Only set for custom
            date ranges. ISO 8601 Formatted.
          type: string
          example: '2024-03-20'
        date_interval:
          description: >-
            The date range for the FinancialCommitmentReport. Only present if a
            custom date range is not specified.
          type: string
          example: last_month
        date_bucket:
          description: >-
            How costs are grouped and displayed in the
            FinancialCommitmentReport. Possible values: day, week, month.
          type: string
          example: month
        groupings:
          description: The grouping aggregations applied to the filtered data.
          type: string
          example: cost_type, tag:account
        on_demand_costs_scope:
          description: 'The scope for the costs. Possible values: discountable, all.'
          type: string
          example: discountable
    KubernetesEfficiencyReports:
      description: KubernetesEfficiencyReports model
      type: object
      properties:
        links:
          type: object
        kubernetes_efficiency_reports:
          type: array
          items:
            $ref: '#/components/schemas/KubernetesEfficiencyReport'
    KubernetesEfficiencyReport:
      description: KubernetesEfficiencyReport model
      type: object
      properties:
        title:
          description: The title of the KubernetesEfficiencyReport.
          type: string
          example: Acme123 Kubernetes Efficiency Metrics
        token:
          type: string
        default:
          description: >-
            Indicates whether the KubernetesEfficiencyReport is the default
            report.
          type: boolean
        created_at:
          description: >-
            The date and time, in UTC, the report was created. ISO 8601
            Formatted.
          type: string
          example: '2024-03-19T00:00:00Z'
        workspace_token:
          description: >-
            The token for the Workspace the KubernetesEfficiencyReport is a part
            of.
          type: string
        user_token:
          description: The token for the User who created this KubernetesEfficiencyReport.
          type: string
        start_date:
          description: >-
            The start date for the KubernetesEfficiencyReport. Only set for
            custom date ranges. ISO 8601 Formatted.
          type: string
          example: '2024-03-01'
        end_date:
          description: >-
            The end date for the KubernetesEfficiencyReport. Only set for custom
            date ranges. ISO 8601 Formatted.
          type: string
          example: '2024-03-20'
        date_interval:
          description: >-
            The date range for the KubernetesEfficiencyReport. Only present if a
            custom date range is not specified.
          type: string
          example: last_month
        date_bucket:
          description: >-
            How costs are grouped and displayed in the
            KubernetesEfficiencyReport. Possible values: day, week, month.
          type: string
          example: month
        aggregated_by:
          description: 'How costs are aggregated by. Possible values: idle_costs, amount.'
          type: string
        groupings:
          description: The grouping aggregations applied to the filtered data.
          type: string
          example: cluster_id, namespace
    AnomalyAlerts:
      description: AnomalyAlerts model
      type: object
      properties:
        links:
          type: object
        anomaly_alerts:
          type: array
          items:
            $ref: '#/components/schemas/AnomalyAlert'
    AnomalyAlert:
      description: AnomalyAlert model
      type: object
      properties:
        token:
          type: string
        created_at:
          description: >-
            The date and time, in UTC, the AnomalyAlert was created. ISO 8601
            Formatted.
          type: string
          example: '2021-07-09T00:00:00Z'
        alerted_at:
          description: >-
            The date and time, in UTC, the AnomalyAlert is sent. ISO 8601
            Formatted.
          type: string
          example: '2021-07-09T00:00:00Z'
        category:
          description: The category of the AnomalyAlert.
          type: string
        service:
          description: The provider service causing the AnomalyAlert.
          type: string
        provider:
          description: The provider of the service causing the AnomalyAlert.
          type: string
        amount:
          description: The amount observed.
          type: string
        previous_amount:
          description: The previous amount observed.
          type: string
        seven_day_average:
          description: The seven day average of the amount observed.
          type: string
        status:
          description: The status of the AnomalyAlert.
          type: string
        feedback:
          description: The user-provided feedback of why alert was ignored/archived.
          type: string
        cost_report_token:
          description: The token of the Report associated with the AnomalyAlert.
          type: string
    updateAnomalyAlert:
      description: Update an AnomalyAlert.
      type: object
      properties:
        status:
          description: The status of the Anomaly Alert.
          type: string
        feedback:
          description: Optional additional comments for why this alert is ignored.
          type: string
      required:
        - status
    createVirtualTagConfig:
      description: Create a new VirtualTagConfig.
      type: object
      properties:
        key:
          description: The key of the VirtualTagConfig.
          type: string
        overridable:
          description: >-
            Whether the VirtualTagConfig can override a provider-supplied tag on
            a matching Cost.
          type: boolean
        backfill_until:
          description: The earliest month the VirtualTagConfig should be backfilled to.
          type: string
          format: date
        values:
          description: >-
            Values for the VirtualTagConfig, with match precedence determined by
            order in the list.
          type: array
          items:
            type: object
            properties:
              name:
                description: The name of the value.
                type: string
              filter:
                description: >-
                  The filter query language to apply to the value. Additional
                  documentation available at https://docs.vantage.sh/vql.
                type: string
            required:
              - name
      required:
        - key
        - overridable
    VirtualTagConfig:
      description: VirtualTagConfig model
      type: object
      properties:
        token:
          description: The token of the VirtualTagConfig.
          type: string
          example: vtag_1234
        created_by_token:
          description: The token of the User who created the VirtualTagConfig.
          type: string
          example: usr_1234
        key:
          description: The key of the VirtualTagConfig.
          type: string
          example: Cost Center
        overridable:
          description: >-
            Whether the VirtualTagConfig can override a provider-supplied tag on
            a matching Cost.
          type: boolean
        backfill_until:
          description: The earliest month VirtualTagConfig should be backfilled to.
          type: string
          example: '2023-10-01'
        values:
          description: >-
            Values for the VirtualTagConfig, with match precedence determined by
            their relative order in the list.
          type: array
          items:
            $ref: '#/components/schemas/VirtualTagConfigValue'
    VirtualTagConfigValue:
      type: object
      properties:
        name:
          description: The name of the Value.
          type: string
          example: Informatics
        filter:
          description: The filter VQL for the Value.
          type: string
          example: >-
            costs.provider = 'aws' AND costs.service = 'Amazon Simple Storage
            Service'
    VirtualTagConfigs:
      description: VirtualTagConfigs model
      type: object
      properties:
        virtual_tag_configs:
          type: array
          items:
            $ref: '#/components/schemas/VirtualTagConfig'
    updateVirtualTagConfig:
      description: Updates an existing VirtualTagConfig.
      type: object
      properties:
        key:
          description: The key of the VirtualTagConfig.
          type: string
        overridable:
          description: >-
            Whether the VirtualTagConfig can override a provider-supplied tag on
            a matching Cost.
          type: boolean
          nullable: true
        backfill_until:
          description: The earliest month the VirtualTagConfig should be backfilled to.
          type: string
          format: date
          nullable: true
        values:
          description: >-
            Values for the VirtualTagConfig, with match precedence determined by
            order in the list.
          type: array
          items:
            type: object
            properties:
              name:
                description: The name of the value.
                type: string
              filter:
                description: >-
                  The filter query language to apply to the value. Additional
                  documentation available at https://docs.vantage.sh/vql.
                type: string
            required:
              - name
    createAnomalyNotification:
      description: Create an Anomaly Notification for a Cost Report.
      type: object
      properties:
        cost_report_token:
          description: The token of the Cost Report folder that has the notification.
          type: string
        threshold:
          description: The threshold amount that must be met for the notification to fire.
          type: integer
          format: int32
        user_tokens:
          description: The tokens of the users that receive the notification.
          type: array
          items:
            type: string
        recipient_channels:
          description: The Slack/MS Teams channels that receive the notification.
          type: array
          items:
            type: string
      required:
        - cost_report_token
    AnomalyNotification:
      description: AnomalyNotification model
      type: object
      properties:
        token:
          type: string
        cost_report_token:
          description: >-
            The token for the CostReport the AnomalyNotification is associated
            with.
          type: string
        created_at:
          description: >-
            The date and time, in UTC, the AnomalyNotification was created. ISO
            8601 Formatted.
          type: string
          example: '2023-08-04T00:00:00Z'
        updated_at:
          description: >-
            The date and time, in UTC, the AnomalyNotification was last updated
            at. ISO 8601 Formatted.
          type: string
          example: '2023-08-04T00:00:00Z'
        threshold:
          description: The threshold amount that must be met for the notification to fire.
          type: integer
          format: int32
        user_tokens:
          description: The tokens of the users that receive the notification.
          type: array
          items:
            type: string
        recipient_channels:
          description: The channels that the notification is sent to.
          type: array
          items:
            type: string
    AnomalyNotifications:
      description: AnomalyNotifications model
      type: object
      properties:
        links:
          type: object
        anomaly_notifications:
          type: array
          items:
            $ref: '#/components/schemas/AnomalyNotification'
    updateAnomalyNotification:
      description: Update an Anomaly Notification.
      type: object
      properties:
        threshold:
          description: The threshold amount that must be met for the notification to fire.
          type: integer
          format: int32
        user_tokens:
          description: The tokens of the users that receive the notification.
          type: array
          items:
            type: string
        recipient_channels:
          description: The Slack/MS Teams channels that receive the notification.
          type: array
          items:
            type: string
    createBudget:
      description: Create a Budget.
      type: object
      properties:
        name:
          description: The name of the Budget.
          type: string
        workspace_token:
          description: The token of the Workspace to add the Budget to.
          type: string
        cost_report_token:
          description: The CostReport token.
          type: string
        periods:
          description: >-
            The periods for the Budget. The start_at and end_at must be iso8601
            formatted e.g. YYYY-MM-DD.
          type: array
          items:
            type: object
            properties:
              start_at:
                description: The start date of the period.
                type: string
                format: date
              end_at:
                description: The end date of the period.
                type: string
                format: date
                nullable: true
              amount:
                description: The amount of the period.
                type: number
                format: double
            required:
              - start_at
              - amount
      required:
        - name
    Budget:
      description: Budget model
      type: object
      properties:
        token:
          type: string
        name:
          description: The name of the Budget.
          type: string
          example: Acme123 Budget
        workspace_token:
          description: The token for the Workspace the Budget is a part of.
          type: string
        user_token:
          description: The token for the User who created this Budget.
          type: string
        cost_report_token:
          description: The token of the Report associated with the Budget.
          type: string
        created_at:
          description: >-
            The date and time, in UTC, the Budget was created. ISO 8601
            Formatted.
          type: string
          example: '2024-03-19T00:00:00Z'
        budget_alert_tokens:
          description: The tokens of the BudgetAlerts associated with the Budget.
          type: array
          items:
            type: string
            example:
              - bdgt_alrt_c9cd4e1a7127461b
        periods:
          description: The budget periods associated with the Budget.
          type: array
          items:
            $ref: '#/components/schemas/BudgetPeriod'
        performance:
          description: The historical performance of the Budget.
          type: array
          items:
            $ref: '#/components/schemas/BudgetPerformance'
    BudgetPeriod:
      type: object
      properties:
        start_at:
          description: >-
            The date and time, in UTC, the Budget was created. ISO 8601
            Formatted.
          type: string
          example: '2024-03-19T00:00:00Z'
        end_at:
          description: >-
            The date and time, in UTC, the Budget was created. ISO 8601
            Formatted.
          type: string
          example: '2024-03-19T00:00:00Z'
        amount:
          description: The amount of the Budget Period as a string to ensure precision.
          type: string
          example: '100.00'
    BudgetPerformance:
      type: object
      properties:
        date:
          description: >-
            The date and time, in UTC, the Budget was created. ISO 8601
            Formatted.
          type: string
          example: '2024-03-19T00:00:00Z'
        actual:
          description: >-
            The date and time, in UTC, the Budget was created. ISO 8601
            Formatted.
          type: string
          example: '2024-03-19T00:00:00Z'
        amount:
          description: The amount of the Budget Period as a string to ensure precision.
          type: string
          example: '100.00'
    Budgets:
      description: Budgets model
      type: object
      properties:
        links:
          type: object
        budgets:
          type: array
          items:
            $ref: '#/components/schemas/Budget'
    updateBudget:
      description: Update a Budget.
      type: object
      properties:
        name:
          description: The name of the Budget.
          type: string
        cost_report_token:
          description: The CostReport token.
          type: string
        periods:
          description: >-
            The periods for the Budget. The start_at and end_at must be iso8601
            formatted e.g. YYYY-MM-DD.
          type: array
          items:
            type: object
            properties:
              start_at:
                description: The start date of the period.
                type: string
                format: date
              end_at:
                description: The end date of the period.
                type: string
                format: date
                nullable: true
              amount:
                description: The amount of the period.
                type: number
                format: double
            required:
              - start_at
              - amount
    BudgetAlert:
      description: BudgetAlert model
      type: object
      properties:
        token:
          type: string
        budget_tokens:
          description: >-
            The tokens for the Budgets that the Budget Alert is monitoring to
            trigger alerts on.
          type: array
          items:
            type: string
            example:
              - bdgt_22dc1ac6e000cd14
              - bdgt_e045e8d2c739cb2c
        created_at:
          description: >-
            The date and time, in UTC, the Budget Alert was created. ISO 8601
            Formatted.
          type: string
          example: '2024-03-19T00:00:00Z'
        workspace_token:
          description: The token for the Workspace the ResourceReport is a part of.
          type: string
        user_token:
          description: The token for the User who created this BudgetAlert.
          type: string
        user_tokens:
          description: The Users that receive the alert.
          type: array
          items:
            type: string
            example:
              - usr_abcd1234
              - usr_efgh5678
        duration_in_days:
          description: >-
            The number of days from the start or end of the month to trigger the
            alert if the threshold is reached.
          type: string
        threshold:
          description: >-
            Alerts only send if they reach this number (as a percentage). When
            threshold is 100, that means alerts are triggered once costs reach
            100% of the budget.
          type: string
          example: '75'
        period_to_track:
          description: >-
            The period tracked on the alert. Used with duration_in_days to
            determine the time window of the alert. Possible values:
            start_of_the_month, end_of_the_month.
          type: string
          example: start_of_the_month
        integration_provider:
          description: >-
            The provider used for sending alerts. This must be configured in the
            console. Possible values are: slack, microsoft_graph.
          type: string
          example: slack
        recipient_channels:
          description: >-
            The channels receiving the alerts. Requires an integration provider
            to be connected.
          type: string
          example:
            - '#budget-notifications'
            - '#finance'
    BudgetAlerts:
      description: BudgetAlerts model
      type: object
      properties:
        links:
          type: object
        budget_alerts:
          type: array
          items:
            $ref: '#/components/schemas/BudgetAlert'
    BusinessMetricsUpdateValuesCsvRequest:
      type: object
      properties:
        csv:
          description: CSV file containing BusinessMetric dates and amounts
          type: string
          format: binary
      required:
        - csv
    BudgetAlertsCreateAlertRequest:
      type: object
      properties:
        budget_tokens:
          description: The tokens of the Budget that has the alert.
          type: array
          items:
            type: string
        threshold:
          description: The threshold amount that must be met for the alert to fire.
          type: integer
          format: int32
        user_tokens:
          description: The tokens of the users that receive the alert.
          type: array
          items:
            type: string
        duration_in_days:
          description: >-
            The number of days from the start or end of the month to trigger the
            alert if the threshold is reached.  For the full month, pass an
            empty value.
          type: integer
          format: int32
        period_to_track:
          description: >-
            The period tracked on the alert. Used with duration_in_days to
            determine the time window of the alert. Defaults to
            start_of_the_month if not passed. Possible values:
            start_of_the_month, end_of_the_month.
          type: string
        recipient_channels:
          description: >-
            The channels receiving the alerts. Requires an integration provider
            to be connected.
          type: array
          items:
            type: string
      required:
        - budget_tokens
        - threshold
        - duration_in_days
    BudgetAlertsUpdateExistingAlertRequest:
      type: object
      properties:
        budget_tokens:
          description: The tokens of the Budget that has the alert.
          type: array
          items:
            type: string
        threshold:
          description: The threshold amount that must be met for the alert to fire.
          type: integer
          format: int32
        user_tokens:
          description: The tokens of the users that receive the alert.
          type: array
          items:
            type: string
        duration_in_days:
          description: >-
            The number of days from the start or end of the month to trigger the
            alert if the threshold is reached. For the full month, pass an empty
            value.
          type: integer
          format: int32
        period_to_track:
          description: >-
            The period tracked on the alert. Used with duration_in_days to
            determine the time window of the alert. Defaults to
            start_of_the_month if not passed. Possible values:
            start_of_the_month, end_of_the_month.
          type: string
        recipient_channels:
          description: >-
            The channels receiving the alerts. Requires an integration provider
            to be connected.
          type: array
          items:
            type: string
security:
  - oauth2:
      - read