Vantage RecommendationViews API

Operations about RecommendationViews

Business capability
IT Financial Management BC-600.80

Operations 5

GET /recommendation_views Get all recommendation views #
POST /recommendation_views Create recommendation view #
GET /recommendation_views/{recommendation_view_token} Get recommendation view by token #
PUT /recommendation_views/{recommendation_view_token} Update recommendation view #
DELETE /recommendation_views/{recommendation_view_token} Delete recommendation view #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/vantage-sh-recommendationviews-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vantage-sh-recommendationviews-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Vantage Recommendation Views API
  description: The Vantage API provides programmatic access to the Vantage cloud cost management and FinOps platform.
  termsOfService: https://www.vantage.sh/terms-of-use
  contact:
    name: Vantage Support
    url: https://www.vantage.sh
    email: support@vantage.sh
  version: 2.0.0
servers:
- url: https://api.vantage.sh/v2
security:
- oauth2:
  - read
tags:
- name: RecommendationViews
  description: Operations about RecommendationViews
paths:
  /recommendation_views:
    get:
      tags:
      - RecommendationViews
      summary: Get all recommendation views
      description: Return all RecommendationViews.
      operationId: getRecommendationViews
      parameters:
      - name: page
        in: query
        description: The page of results to return.
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: The amount of results to return. The maximum is 1000.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendationViews'
              example:
                links:
                  self: https://api.vantage.sh/v2/recommendation_views
                  first: https://api.vantage.sh/v2/recommendation_views?page=1
                  next: null
                  last: https://api.vantage.sh/v2/recommendation_views?page=1
                  prev: null
                recommendation_views:
                - token: rec_vw_3dffc0458f7a2487
                  title: Production Recommendations
                  workspace_token: wrkspc_914dcb0959497507
                  start_date: '2024-01-01'
                  end_date: '2024-12-31'
                  provider_ids:
                  - aws
                  - gcp
                  billing_account_ids: []
                  account_ids:
                  - '123456789012'
                  regions:
                  - us-east-1
                  - us-west-2
                  tag_key: environment
                  tag_value: production
                  created_at: '2024-07-15T16:08:53Z'
                  created_by: usr_95fac32734bdceab
      security:
      - oauth2:
        - read
    post:
      tags:
      - RecommendationViews
      summary: Create recommendation view
      description: Create a RecommendationView.
      operationId: createRecommendationView
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createRecommendationView'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendationView'
              example:
                token: rec_vw_a1b2c3d4e5f67890
                title: Staging Recommendations
                workspace_token: wrkspc_be6568a301b1d06c
                start_date: '2024-01-01'
                end_date: '2024-06-30'
                provider_ids:
                - aws
                billing_account_ids: []
                account_ids: []
                regions: []
                tag_key: environment
                tag_value: staging
                created_at: '2024-07-15T16:10:00Z'
                created_by: usr_95fac32734bdceab
        '400':
          description: BadRequest
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: UnprocessableEntity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      security:
      - oauth2:
        - write
      x-codegen-request-body-name: createRecommendationView
  /recommendation_views/{recommendation_view_token}:
    get:
      tags:
      - RecommendationViews
      summary: Get recommendation view by token
      description: Return a specific RecommendationView.
      operationId: getRecommendationView
      parameters:
      - name: recommendation_view_token
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendationView'
              example:
                token: rec_vw_be3f24eb1b5aabf6
                title: Production Recommendations
                workspace_token: wrkspc_be6568a301b1d06c
                start_date: '2024-01-01'
                end_date: '2024-12-31'
                provider_ids:
                - aws
                - gcp
                billing_account_ids: []
                account_ids:
                - '123456789012'
                regions:
                - us-east-1
                - us-west-2
                tag_key: environment
                tag_value: production
                created_at: '2024-07-15T16:08:54Z'
                created_by: team_73f6001f98e9012b
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      security:
      - oauth2:
        - read
    put:
      tags:
      - RecommendationViews
      summary: Update recommendation view
      description: Update a RecommendationView.
      operationId: updateRecommendationView
      parameters:
      - name: recommendation_view_token
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateRecommendationView'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendationView'
              example:
                token: rec_vw_be3f24eb1b5aabf6
                title: Updated Recommendations View
                workspace_token: wrkspc_be6568a301b1d06c
                start_date: '2024-01-01'
                end_date: '2024-12-31'
                provider_ids:
                - aws
                - gcp
                - azure
                billing_account_ids: []
                account_ids:
                - '123456789012'
                - '987654321098'
                regions:
                - us-east-1
                - us-west-2
                - ap-northeast-2
                tag_key: environment
                tag_value: production
                created_at: '2024-07-15T16:08:54Z'
                created_by: team_73f6001f98e9012b
        '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'
      security:
      - oauth2:
        - write
      x-codegen-request-body-name: updateRecommendationView
    delete:
      tags:
      - RecommendationViews
      summary: Delete recommendation view
      description: Delete a RecommendationView.
      operationId: deleteRecommendationView
      parameters:
      - name: recommendation_view_token
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecommendationView'
        '404':
          description: NotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      security:
      - oauth2:
        - write
components:
  schemas:
    Errors:
      required:
      - errors
      type: object
      properties:
        links:
          $ref: '#/components/schemas/Links'
        errors:
          type: array
          items:
            type: string
      description: Errors model
    Links:
      type: object
      properties:
        self:
          type:
          - string
          - 'null'
          description: The URL of the current page of results.
        first:
          type:
          - string
          - 'null'
          description: The URL of the first page of results.
        next:
          type:
          - string
          - 'null'
          description: The URL of the next page of results, if one exists.
        last:
          type:
          - string
          - 'null'
          description: The URL of the last page of results, if one exists.
        prev:
          type:
          - string
          - 'null'
          description: The URL of the previous page of results, if one exists.
    RecommendationView:
      type: object
      properties:
        token:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
          description: The title of the RecommendationView.
          example: Production Recommendations
        workspace_token:
          type:
          - string
          - 'null'
          description: The token for the Workspace the RecommendationView is a part of.
        start_date:
          type:
          - string
          - 'null'
          description: Filter recommendations created on/after this YYYY-MM-DD date.
          example: '2024-01-01'
        end_date:
          type:
          - string
          - 'null'
          description: Filter recommendations created on/before this YYYY-MM-DD date.
          example: '2024-12-31'
        provider_ids:
          type:
          - array
          - 'null'
          description: Filter by one or more providers.
          items:
            type: string
            example: ''
        billing_account_ids:
          type:
          - array
          - 'null'
          description: Filter by billing account identifiers.
          items:
            type: string
            example: ''
        account_ids:
          type:
          - array
          - 'null'
          description: Filter by cloud account identifiers.
          items:
            type: string
            example: ''
        regions:
          type:
          - array
          - 'null'
          description: Filter by region slugs (e.g. us-east-1, eastus, asia-east1).
          items:
            type: string
            example: ''
        types:
          type:
          - array
          - 'null'
          description: Filter by one or more recommendation type slugs.
          items:
            type: string
            example: ''
        tag_key:
          type:
          - string
          - 'null'
          description: Filter by tag key (must be used with tag_value).
          example: environment
        tag_value:
          type:
          - string
          - 'null'
          description: Filter by tag value (requires tag_key).
          example: production
        min_savings:
          type:
          - number
          - 'null'
          description: Filter recommendations with at least this amount of potential savings.
          format: float
          example: 100.5
        created_at:
          type:
          - string
          - 'null'
          description: The date and time, in UTC, the view was created. ISO 8601 Formatted.
          example: '2023-08-04T00:00:00Z'
        created_by:
          type:
          - string
          - 'null'
          description: The token for the Creator of this RecommendationView.
      description: RecommendationView model
    updateRecommendationView:
      type: object
      properties:
        title:
          type: string
          description: The title of the RecommendationView.
        provider_ids:
          type: array
          description: Filter by one or more providers (e.g. aws, gcp, azure, kubernetes, datadog).
          items:
            type: string
        billing_account_ids:
          type: array
          description: Filter by billing account identifiers.
          items:
            type: string
        account_ids:
          type: array
          description: Filter by cloud account identifiers.
          items:
            type: string
        regions:
          type: array
          description: Filter by region slugs (e.g. us-east-1, eastus, asia-east1).
          items:
            type: string
        types:
          type: array
          description: Filter by one or more recommendation type slugs.
          items:
            type: string
        tag_key:
          type: string
          description: Filter by tag key (must be used with tag_value).
        tag_value:
          type: string
          description: Filter by tag value (requires tag_key).
        start_date:
          type: string
          description: Filter recommendations created on/after this YYYY-MM-DD date.
        end_date:
          type: string
          description: Filter recommendations created on/before this YYYY-MM-DD date.
        min_savings:
          type: number
          description: Filter recommendations with at least this amount of potential savings.
          format: float
      description: Update a RecommendationView.
    RecommendationViews:
      type: object
      properties:
        links:
          $ref: '#/components/schemas/Links'
        recommendation_views:
          type: array
          items:
            $ref: '#/components/schemas/RecommendationView'
      description: RecommendationViews model
    createRecommendationView:
      required:
      - title
      - workspace_token
      type: object
      properties:
        title:
          type: string
          description: The title of the RecommendationView.
        workspace_token:
          type: string
          description: The Workspace to associate the RecommendationView with.
        provider_ids:
          type: array
          description: Filter by one or more providers (e.g. aws, gcp, azure, kubernetes, datadog).
          items:
            type: string
        billing_account_ids:
          type: array
          description: Filter by billing account identifiers.
          items:
            type: string
        account_ids:
          type: array
          description: Filter by cloud account identifiers.
          items:
            type: string
        regions:
          type: array
          description: Filter by region slugs (e.g. us-east-1, eastus, asia-east1).
          items:
            type: string
        types:
          type: array
          description: Filter by one or more recommendation type slugs.
          items:
            type: string
        tag_key:
          type: string
          description: Filter by tag key (must be used with tag_value).
        tag_value:
          type: string
          description: Filter by tag value (requires tag_key).
        start_date:
          type: string
          description: Filter recommendations created on/after this YYYY-MM-DD date.
        end_date:
          type: string
          description: Filter recommendations created on/before this YYYY-MM-DD date.
        min_savings:
          type: number
          description: Filter recommendations with at least this amount of potential savings.
          format: float
      description: Create a RecommendationView.
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://console.vantage.sh/account/profile
          scopes:
            read: Grants read access
            write: Grants write access
x-original-swagger-version: '2.0'