Costfluent Public API

List saved filters

GET
https://api.costfluent.com
/v1/saved-filters
Bearer (API token)

Returns all saved filters for a workspace.

Needs a token with viewCostReports on the workspace.

List saved filters › 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 saved filters › Responses

Success

​PaginationLinks · required
​SavedFilterResponse[] · required

Create saved filter

POST
https://api.costfluent.com
/v1/saved-filters
Bearer (API token)

Creates a reusable filter configuration.

Needs a token with createSavedFilter on the workspace.

Create saved filter › 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 saved filter › Request Body

workspaceId
​WorkspacePublicId · minLength: 1 · pattern: ^wsp_[A-Za-z0-9_-]{2… · required
title
​string · minLength: 0 · maxLength: 200 · required
filter
​string · minLength: 1 · required
isDefault
​boolean

Create saved filter › Responses

Created

id
​SavedFilterPublicId · pattern: ^flt_[A-Za-z0-9_-]{2… · required
title
​string · required

Get saved filter

GET
https://api.costfluent.com
/v1/saved-filters/{filterId}
Bearer (API token)

Returns a specific saved filter.

Needs a token with viewCostReports on the workspace.

Get saved filter › path Parameters

filterId
​SavedFilterPublicId · pattern: ^flt_[A-Za-z0-9_-]{2… · required

Get saved filter › query Parameters

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

Get saved filter › Responses

Success

id
​SavedFilterPublicId · pattern: ^flt_[A-Za-z0-9_-]{2… · required
title
​string · required
filter
​string · required
isDefault
​boolean · required
createdAt
​string · date-time · required

Update saved filter

PUT
https://api.costfluent.com
/v1/saved-filters/{filterId}
Bearer (API token)

Updates a saved filter.

Needs a token with updateSavedFilter on the workspace.

Update saved filter › path Parameters

filterId
​SavedFilterPublicId · pattern: ^flt_[A-Za-z0-9_-]{2… · required

Update saved filter › query Parameters

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

Update saved filter › 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 saved filter › Request Body

title
​string | null
filter
​string | null
isDefault
​boolean | null

Update saved filter › Responses

Success

id
​SavedFilterPublicId · pattern: ^flt_[A-Za-z0-9_-]{2… · required
title
​string · required
filter
​string · required
isDefault
​boolean · required
createdAt
​string · date-time · required

Delete saved filter

DELETE
https://api.costfluent.com
/v1/saved-filters/{filterId}
Bearer (API token)

Deletes a saved filter.

Needs a token with deleteSavedFilter on the workspace.

Delete saved filter › path Parameters

filterId
​SavedFilterPublicId · pattern: ^flt_[A-Za-z0-9_-]{2… · required

Delete saved filter › query Parameters

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

Delete saved filter › 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 saved filter › Responses

No Content

No data returned