Skip to main content
POST
/
resource_reports
Create resource report
curl --request POST \
  --url https://api.vantage.sh/v2/resource_reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_token": "<string>",
  "title": "<string>",
  "filter": "<string>",
  "columns": [
    "<string>"
  ]
}
'
{
  "token": "prvdr_rsrc_rprt_d881b5362adab1c2",
  "title": "EC2 Report",
  "filter": "resources.provider = 'aws' and resources.type = 'aws_instance'",
  "created_at": "2025-08-14T19:13:32Z",
  "workspace_token": "wrkspc_e5a36fbae0021598",
  "user_token": null,
  "created_by_token": "team_16f0d31149f3254a",
  "columns": [
    "provider",
    "label",
    "accrued_costs",
    "recommendation_savings",
    "resource",
    "type",
    "region",
    "account"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Create a ResourceReport.

​
workspace_token
string
required

The token of the Workspace to add the ResourceReport to.

​
title
string

The title of the ResourceReport.

​
filter
string

The filter query language to apply to the ResourceReport. Additional documentation available at https://docs.vantage.sh/vql.

​
columns
string[]

Array of column names to display in the table. Column names should match those returned by the /resource_reports/columns endpoint. The order determines the display order. Only available for reports with a single resource type filter.

Response

ResourceReport model

​
token
string
​
title
string

The title of the ResourceReport.

Example:

"Acme123 Active Resources"

​
filter
string

The filter applied to the ResourceReport. Additional documentation available at https://docs.vantage.sh/vql.

​
created_at
string

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

Example:

"2024-03-19T00:00:00Z"

​
workspace_token
string

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

​
user_token
string

The token for the User who created this ResourceReport.

​
created_by_token
string

The token for the User or Team who created this ResourceReport.

​
columns
string[]

Array of column names configured for the ResourceReport table display.