Savings

Download schema

List savings views

GET

https://api.costfluent.com

/v1/savings-views

Bearer (API token)

Returns the workspace's saved views of the savings queue, by title.

Needs a token with viewSavingsItems on the workspace.

List savings views › query Parameters

workspaceId

WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

page

integer · int32

The page to return, counted from 1. A page below 1 reads page 1; one past the last returns no items.

Default: 1

limit

integer · int32

Items per page, from 1 to 100. A larger value is clamped to 100, a smaller one to 1.

Default: 20

List savings views › Responses

Success

PaginatedResponseOfSavingsViewResponse

PaginationLinks · required

SavingsViewResponse[] · required

Create savings view

POST

https://api.costfluent.com

/v1/savings-views

Bearer (API token)

Saves a set of savings queue filters as a named view of the workspace.

Needs a token with manageSavingsItems on the workspace.

Create savings view › Headers

Idempotency-Key

string · minLength: 1 · maxLength: 255

A unique value, at most 255 printable ASCII characters, such as a UUID, that makes retrying this create safe. A retry with the same key and the same request within 24 hours answers the first response again, marked Idempotent-Replayed: true, and creates nothing; the same key with another request answers 422 idempotency_key_reused. A key is kept only for a create that succeeded. Without it, every request creates.

Create savings view › Request Body

CreateSavingsViewRequest

workspaceId

WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

title

string · minLength: 1 · required

tab

SavingsQueueTab · required

minimumMonthlySaving

string | null · decimal · min: 0 · pattern: ^-?[0-9]+(\.[0-9]{1,…

Create savings view › Responses

Created

SavingsViewResponse

id

SavingsViewPublicId · pattern: ^svw_[A-Za-z0-9_-]{2… · required

title

string · required

tab

SavingsQueueTab · required

createdAt

string · date-time · required

minimumMonthlySaving

string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

updatedAt

string | null · date-time

POST/v1/savings-views

curl https://api.costfluent.com/v1/savings-views \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "workspaceId": "workspaceId",
  "title": "title",
  "tab": "tab",
  "source": "string",
  "kind": "string",
  "cloudAccountId": "string",
  "minimumMonthlySaving": "minimumMonthlySaving"
}'

Example Request Body

{
  "workspaceId": "workspaceId",
  "title": "title",
  "tab": "tab",
  "source": "string",
  "kind": "string",
  "cloudAccountId": "string",
  "minimumMonthlySaving": "minimumMonthlySaving"
}

json

Example Responses

{
  "id": "id",
  "title": "title",
  "tab": "tab",
  "source": "string",
  "kind": "string",
  "cloudAccountId": "string",
  "minimumMonthlySaving": "minimumMonthlySaving",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Get savings view

GET

https://api.costfluent.com

/v1/savings-views/{savingsViewId}

Bearer (API token)

Returns a saved view of the workspace's savings queue.

Needs a token with viewSavingsItems on the workspace.

Get savings view › path Parameters

savingsViewId

SavingsViewPublicId · pattern: ^svw_[A-Za-z0-9_-]{2… · required

Get savings view › query Parameters

workspaceId

WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

Get savings view › Responses

Success

SavingsViewResponse

id

SavingsViewPublicId · pattern: ^svw_[A-Za-z0-9_-]{2… · required

title

string · required

tab

SavingsQueueTab · required

createdAt

string · date-time · required

minimumMonthlySaving

string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

updatedAt

string | null · date-time

Update savings view

PUT

https://api.costfluent.com

/v1/savings-views/{savingsViewId}

Bearer (API token)

Replaces a saved view whole: its title and every filter, a filter left out being cleared.

Needs a token with manageSavingsItems on the workspace.

Update savings view › path Parameters

savingsViewId

SavingsViewPublicId · pattern: ^svw_[A-Za-z0-9_-]{2… · required

Update savings view › query Parameters

workspaceId

WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

Update savings view › Headers

If-Match

string

Applies the write only while the resource still has this ETag, and answers 412 precondition_failed otherwise. Without it, the last write wins.

Update savings view › Request Body

UpdateSavingsViewRequest

title

string · minLength: 1 · required

tab

SavingsQueueTab · required

minimumMonthlySaving

string | null · decimal · min: 0 · pattern: ^-?[0-9]+(\.[0-9]{1,…

Update savings view › Responses

Success

SavingsViewResponse

id

SavingsViewPublicId · pattern: ^svw_[A-Za-z0-9_-]{2… · required

title

string · required

tab

SavingsQueueTab · required

createdAt

string · date-time · required

minimumMonthlySaving

string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

updatedAt

string | null · date-time

PUT/v1/savings-views/{savingsViewId}

curl 'https://api.costfluent.com/v1/savings-views/:savingsViewId?workspaceId=<string>' \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "title": "title",
  "tab": "tab",
  "source": "string",
  "kind": "string",
  "cloudAccountId": "string",
  "minimumMonthlySaving": "minimumMonthlySaving"
}'

Example Request Body

{
  "title": "title",
  "tab": "tab",
  "source": "string",
  "kind": "string",
  "cloudAccountId": "string",
  "minimumMonthlySaving": "minimumMonthlySaving"
}

json

Example Responses

{
  "id": "id",
  "title": "title",
  "tab": "tab",
  "source": "string",
  "kind": "string",
  "cloudAccountId": "string",
  "minimumMonthlySaving": "minimumMonthlySaving",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Delete savings view

DELETE

https://api.costfluent.com

/v1/savings-views/{savingsViewId}

Bearer (API token)

Deletes a saved view of the savings queue; the findings it listed stay.

Needs a token with manageSavingsItems on the workspace.

Delete savings view › path Parameters

savingsViewId

SavingsViewPublicId · pattern: ^svw_[A-Za-z0-9_-]{2… · required

Delete savings view › query Parameters

workspaceId

WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

Delete savings view › Headers

If-Match

string

Applies the write only while the resource still has this ETag, and answers 412 precondition_failed otherwise. Without it, the last write wins.

Delete savings view › Responses

No Content

No data returned

Get savings finding

GET

https://api.costfluent.com

/v1/savings-items/{savingsItemId}

Bearer (API token)

Returns one finding of the workspace's savings queue with its evidence and its latest measurement. A curated finding is found only on a plan that includes curated savings.

Needs a token with viewSavingsItems on the workspace.

Get savings finding › path Parameters

savingsItemId

SavingsItemPublicId · pattern: ^sav_[A-Za-z0-9_-]{2… · required

Get savings finding › query Parameters

workspaceId

WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

Get savings finding › Responses

Success

SavingsItemResponse

id

SavingsItemPublicId · pattern: ^sav_[A-Za-z0-9_-]{2… · required

title

string · required

evidence

string · required

estimatedMonthlySaving

string · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,… · required

currency

string · pattern: ^[A-Z]{3}$ · required

costBasis

string · required

owner

string · required

confidence

SavingsItemRating · required

risk

SavingsItemRating · required

effort

SavingsItemRating · required

status

SavingsItemStatus · required

source

SavingsItemSource · required

createdAt

string · date-time · required

rejectionReason

string | null

verifiedMonthlySaving

string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

resource

string | null

scope

string | null

lastSeenAt

string | null · date-time

lastMeasurementScope

string | null

lastMeasurementRealizedMonthly

string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

lastMeasuredAt

string | null · date-time

acceptedAt

string | null · date-time

implementedAt

string | null · date-time

verifiedAt

string | null · date-time

rejectedAt

string | null · date-time

updatedAt

string | null · date-time

GET/v1/savings-items/{savingsItemId}

curl 'https://api.costfluent.com/v1/savings-items/:savingsItemId?workspaceId=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "id",
  "title": "title",
  "evidence": "evidence",
  "estimatedMonthlySaving": "estimatedMonthlySaving",
  "currency": "currency",
  "costBasis": "costBasis",
  "owner": "owner",
  "confidence": "confidence",
  "risk": "risk",
  "effort": "effort",
  "status": "status",
  "rejectionReason": "rejectionReason",
  "verifiedMonthlySaving": "verifiedMonthlySaving",
  "source": "source",
  "kind": "string",
  "resource": "resource",
  "scope": "scope",
  "lastSeenAt": "2024-08-25T15:00:00Z",
  "lastMeasurementOutcome": "string",
  "lastMeasurementScope": "lastMeasurementScope",
  "lastMeasurementRealizedMonthly": "lastMeasurementRealizedMonthly",
  "lastMeasuredAt": "2024-08-25T15:00:00Z",
  "acceptedAt": "2024-08-25T15:00:00Z",
  "implementedAt": "2024-08-25T15:00:00Z",
  "verifiedAt": "2024-08-25T15:00:00Z",
  "rejectedAt": "2024-08-25T15:00:00Z",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

List savings findings

GET

https://api.costfluent.com

/v1/savings-items

Bearer (API token)

Returns the workspace's savings queue: one tab's findings, or every status without one, narrowed by source, kind, the connection that generated them and a minimum monthly saving, newest first or largest saving first. Costfluent's curated findings are listed only on a plan that includes them. An unknown cloudAccountId matches no finding.

Needs a token with viewSavingsItems on the workspace.

List savings findings › query Parameters

workspaceId

WorkspacePublicId · pattern: ^wsp_[A-Za-z0-9_-]{2… · required

tab

string

source

string

kind

string

cloudAccountId

minimumMonthlySaving

string | null · decimal · pattern: ^-?[0-9]+(\.[0-9]{1,…

sort

string · enum

Enum values:

newest

largestSaving

Default: newest

page

integer · int32

The page to return, counted from 1. A page below 1 reads page 1; one past the last returns no items.

Default: 1

limit

integer · int32

Items per page, from 1 to 100. A larger value is clamped to 100, a smaller one to 1.

Default: 20

List savings findings › Responses

Success

PaginatedResponseOfSavingsItemResponse

PaginationLinks · required

SavingsItemResponse[] · required

GET/v1/savings-items

curl 'https://api.costfluent.com/v1/savings-items?workspaceId=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "links": {
    "self": "self",
    "first": "first",
    "prev": "prev",
    "next": "next",
    "last": "last"
  },
  "data": [
    {
      "id": "id",
      "title": "title",
      "evidence": "evidence",
      "estimatedMonthlySaving": "estimatedMonthlySaving",
      "currency": "currency",
      "costBasis": "costBasis",
      "owner": "owner",
      "confidence": "confidence",
      "risk": "risk",
      "effort": "effort",
      "status": "status",
      "rejectionReason": "rejectionReason",
      "verifiedMonthlySaving": "verifiedMonthlySaving",
      "source": "source",
      "kind": "string",
      "resource": "resource",
      "scope": "scope",
      "lastSeenAt": "2024-08-25T15:00:00Z",
      "lastMeasurementOutcome": "string",
      "lastMeasurementScope": "lastMeasurementScope",
      "lastMeasurementRealizedMonthly": "lastMeasurementRealizedMonthly",
      "lastMeasuredAt": "2024-08-25T15:00:00Z",
      "acceptedAt": "2024-08-25T15:00:00Z",
      "implementedAt": "2024-08-25T15:00:00Z",
      "verifiedAt": "2024-08-25T15:00:00Z",
      "rejectedAt": "2024-08-25T15:00:00Z",
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Tags Saved Filters