Savings Estimate

API for estimating savings from uploaded billing files

Estimate savings from an uploaded billing file

post

Parses a completed PDF, CSV, JSON, or text billing upload and returns normalized costs and provider-specific savings estimates.

Path parameters

org_idstring · uuidRequired

Body

application/json

upload_idstring · uuidRequired

Responses

200

OK

application/json

providerstring,null · enum · nullableRequiredPossible values:

source_formatstringRequired

period_startstring · nullableRequired

period_endstring · nullableRequired

account_idstring · nullableRequired

currencystringRequired

is_projectedbooleanRequired

extraction_statusundefined · enumRequiredPossible values:

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

405

Method not allowed

application/json

409

Conflict

application/json

422

Unprocessable Content

application/json

500

Internal server error

application/json

default

Default error response

application/json

post/v1/org/{org_id}/savings-estimate

HTTPcURLJavaScriptPython

POST /v1/org/{org_id}/savings-estimate HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "upload_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "provider": "aws",
  "source_format": "text",
  "period_start": null,
  "period_end": null,
  "account_id": null,
  "currency": "text",
  "is_projected": true,
  "extraction_status": "complete",
  "line_items": [
    {
      "service": "text",
      "reservable_service": null,
      "resource_type": null,
      "usage_quantity": {
        "estimate": 1,
        "lower_bound": null,
        "upper_bound": null
      },
      "usage_unit": null,
      "cost": {
        "estimate": 1,
        "lower_bound": null,
        "upper_bound": null
      },
      "region": null,
      "spend_type": "on_demand",
      "savings_estimate": {
        "estimate": 1,
        "lower_bound": null,
        "upper_bound": null
      }
    }
  ],
  "total_cost": {
    "estimate": 1,
    "lower_bound": null,
    "upper_bound": null
  },
  "total_savings_estimate": {
    "estimate": 1,
    "lower_bound": null,
    "upper_bound": null
  }
}