/costs/data_exports

post https://api.vantage.sh/v2/costs/data_exports

Generate a DataExport of costs.

Query Params

groupings

array of strings

Group the results by specific field(s). Defaults to provider, service, account_id. Valid groupings: account_id, billing_account_id, charge_type, cost_category, cost_subcategory, provider, region, resource_id, service, tagged, tag:<tag_value>. If providing multiple groupings, join as comma separated values: groupings=provider,service,region

groupings

Form Data

cost_report_token

string

The CostReport token.

filter

string

The VQL filter to apply to the costs. If this is supplied you do not need cost_report_token.

start_date

string

First date you would like to filter costs from. ISO 8601 formatted.

end_date

string

Last date you would like to filter costs to. ISO 8601 formatted.

date_bin

string

The date bin of the costs. Defaults to the report's default or day.

settings[include_credits]

boolean

Defaults to false

Results will include credits.

settings[include_refunds]

boolean

Defaults to false

Results will include refunds.

settings[include_discounts]

boolean

Defaults to true

Results will include discounts.

settings[include_tax]

boolean

Defaults to true

Results will include tax.

settings[amortize]

boolean

Defaults to true

Results will amortize.

settings[unallocated]

boolean

Defaults to false

Results will show unallocated costs.

settings[aggregate_by]

string

Defaults to cost

Results will aggregate by cost or usage.

Responses

202

The data export has been queued and will be available at the location specified in the Location header.

Language

Credentials

OAuth2


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://api.vantage.sh/v2/costs/data_exports \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/x-www-form-urlencoded' \
5
     --data-urlencode settings%5Binclude_credits%5D=false \
6
     --data-urlencode settings%5Binclude_refunds%5D=false \
7
     --data-urlencode settings%5Binclude_discounts%5D=true \
8
     --data-urlencode settings%5Binclude_tax%5D=true \
9
     --data-urlencode settings%5Bamortize%5D=true \
10
     --data-urlencode settings%5Bunallocated%5D=false \
11
     --data-urlencode settings%5Baggregate_by%5D=cost

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400BadRequest

402PaymentRequired

404NotFound