Skip to main content
POST
/
saved_filters
Create saved filter
curl --request POST \
  --url https://api.vantage.sh/v2/saved_filters \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "workspace_token": "<string>",
  "filter": "<string>"
}
'
{
  "token": "svd_fltr_4de629566ddd68c9",
  "title": "New Saved Filter",
  "cost_report_tokens": [],
  "filter": "costs.provider = 'datadog'",
  "created_at": "2024-07-15T16:08:58Z",
  "created_by": "team_e58399e4df1175e9",
  "workspace_token": "wrkspc_e4cacf2493142e5b"
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Create a SavedFilter for CostReports.

title
string
required

The title of the SavedFilter.

workspace_token
string

The Workspace to associate the SavedFilter with. Required if the API token is associated with multiple Workspaces.

filter
string

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.

Response

SavedFilter model

token
string
required
title
string
required

The title of the SavedFilter.

Example:

"Platform Team Reports"

cost_report_tokens
string[]
required

The tokens for any CostReports the SavedFilter is applied to.

filter
string | null
required

The SavedFilter's filter, applied to any relevant CostReports. Additional documentation available at https://docs.vantage.sh/vql.

Example:

"costs.provider = 'azure'"

created_at
string
required

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

Example:

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

created_by
string | null
required

The token for the Creator of this SavedFilter.

workspace_token
string
required

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