Skip to main content
POST
/
recommendation_views
Create recommendation view
curl --request POST \
  --url https://api.vantage.sh/v2/recommendation_views \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "workspace_token": "<string>",
  "provider_ids": [
    "<string>"
  ],
  "billing_account_ids": [
    "<string>"
  ],
  "account_ids": [
    "<string>"
  ],
  "regions": [
    "<string>"
  ],
  "types": [
    "<string>"
  ],
  "tag_key": "<string>",
  "tag_value": "<string>",
  "start_date": "<string>",
  "end_date": "<string>",
  "min_savings": 123
}
'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vantage.sh/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Create a RecommendationView.

​
title
string
required

The title of the RecommendationView.

​
workspace_token
string
required

The Workspace to associate the RecommendationView with.

​
provider_ids
string[]

Filter by one or more providers (e.g. aws, gcp, azure, kubernetes, datadog).

​
billing_account_ids
string[]

Filter by billing account identifiers.

​
account_ids
string[]

Filter by cloud account identifiers.

​
regions
string[]

Filter by region slugs (e.g. us-east-1, eastus, asia-east1).

​
types
string[]

Filter by one or more recommendation type slugs.

​
tag_key
string

Filter by tag key (must be used with tag_value).

​
tag_value
string

Filter by tag value (requires tag_key).

​
start_date
string

Filter recommendations created on/after this YYYY-MM-DD date.

​
end_date
string

Filter recommendations created on/before this YYYY-MM-DD date.

​
min_savings
number<float>

Filter recommendations with at least this amount of potential savings.

Response

RecommendationView model

​
token
string | null
​
title
string | null

The title of the RecommendationView.

Example:

"Production Recommendations"

​
workspace_token
string | null

The token for the Workspace the RecommendationView is a part of.

​
start_date
string | null

Filter recommendations created on/after this YYYY-MM-DD date.

Example:

"2024-01-01"

​
end_date
string | null

Filter recommendations created on/before this YYYY-MM-DD date.

Example:

"2024-12-31"

​
provider_ids
string[] | null

Filter by one or more providers.

​
billing_account_ids
string[] | null

Filter by billing account identifiers.

​
account_ids
string[] | null

Filter by cloud account identifiers.

​
regions
string[] | null

Filter by region slugs (e.g. us-east-1, eastus, asia-east1).

​
types
string[] | null

Filter by one or more recommendation type slugs.

​
tag_key
string | null

Filter by tag key (must be used with tag_value).

Example:

"environment"

​
tag_value
string | null

Filter by tag value (requires tag_key).

Example:

"production"

​
min_savings
number<float> | null

Filter recommendations with at least this amount of potential savings.

Example:

100.5

​
created_at
string | null

The date and time, in UTC, the view was created. ISO 8601 Formatted.

Example:

"2023-08-04T00:00:00Z"

​
created_by
string | null

The token for the Creator of this RecommendationView.