Skip to main content
GET
/
cost_reports
Get all cost reports
curl --request GET \
  --url https://api.vantage.sh/v2/cost_reports \
  --header 'Authorization: Bearer <token>'
{
  "links": {
    "self": "https://api.vantage.sh/v2/cost_reports",
    "first": "https://api.vantage.sh/v2/cost_reports?page=1",
    "next": null,
    "last": "https://api.vantage.sh/v2/cost_reports?page=1",
    "prev": null
  },
  "cost_reports": [
    {
      "token": "rprt_403b6516ad289a52",
      "title": "Untitled",
      "folder_token": null,
      "saved_filter_tokens": [
        "svd_fltr_03a9f354fe7cad59"
      ],
      "business_metric_tokens_with_metadata": [],
      "filter": null,
      "groupings": "service,provider",
      "settings": {
        "include_credits": false,
        "include_refunds": false,
        "include_discounts": true,
        "include_tax": true,
        "amortize": true,
        "unallocated": false,
        "aggregate_by": "cost",
        "show_previous_period": true
      },
      "created_at": "2024-07-03T00:00:00Z",
      "workspace_token": "wrkspc_b7743329296e6e96",
      "previous_period_start_date": null,
      "previous_period_end_date": null,
      "start_date": "2024-07-01",
      "end_date": "2024-07-31",
      "date_interval": "this_month",
      "chart_type": "line",
      "date_bin": "cumulative",
      "chart_settings": {
        "y_axis_dimension": "cost",
        "x_axis_dimension": [
          "date"
        ]
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer<int32>

The page of results to return.

limit
integer<int32>

The amount of results to return. The maximum is 1000.

folder_token
string

The token for the Folder you would like to fetch Reports from.

Response

200 - application/json

CostReports model

cost_reports
object[]