Costfluent Docs
  • Documentation
  • API Reference
Information
Workspaces
    List workspacesgetCreate workspacepostGet workspacegetUpdate workspaceputDelete workspacedeleteGet the workspace's exchange rate policyget
Virtual Tags
    Activate virtual tagpostList virtual tagsgetCreate virtual tagpostDeactivate virtual tagpostGet virtual taggetDelete virtual tagdeleteUpdate virtual tagpatch
Virtual-Tags
    Activate virtual tagpostList virtual tagsgetCreate virtual tagpostDeactivate virtual tagpostGet virtual taggetDelete virtual tagdeleteUpdate virtual tagpatch
Utility
    Get current token infogetHealth checkget
Me
    Get current token infoget
Ping
    Health checkget
Tags
    Get tag keygetDelete tag keydeleteList tag keysget
Tag-Keys
    Get tag keygetDelete tag keydeleteList tag keysget
Saved Filters
    List saved filtersgetCreate saved filterpostGet saved filtergetUpdate saved filterputDelete saved filterdelete
Saved-Filters
    List saved filtersgetCreate saved filterpostGet saved filtergetUpdate saved filterputDelete saved filterdelete
Providers
    List providersgetConnect providerpostGet providergetDelete providerdeleteGet available providersgetGet provider sync historygetTest provider connectionpostTrigger provider syncpostUpdate providerput
Folders
    List foldersgetCreate folderpostGet foldergetUpdate folderputDelete folderdelete
Exchange Rates
    Get available currenciesgetGet exchange rategetGet the workspace's exchange rate policygetList exchange ratesget
Exchange-Rates
    Get available currenciesgetGet exchange rategetList exchange ratesget
Dashboards
    List dashboardsgetCreate dashboardpostGet dashboardgetUpdate dashboardputDelete dashboarddelete
Custom Provider
    Submit costs batchpost
Custom-Providers
    Submit costs batchpost
Report Notifications
    Activate report notificationpostList report notificationsgetCreate report notificationpostDeactivate report notificationpostGet report notificationgetDelete report notificationdeleteUpdate report notificationpatch
Cost-Report-Subscriptions
    Activate report notificationpostList report notificationsgetCreate report notificationpostDeactivate report notificationpostGet report notificationgetDelete report notificationdeleteUpdate report notificationpatch
Cost Reports
    List cost reportsgetCreate cost reportpostGet cost reportgetUpdate cost reportputDelete cost reportdeleteGet cost report dataget
Cost-Reports
    List cost reportsgetCreate cost reportpostGet cost reportgetUpdate cost reportputDelete cost reportdeleteGet cost report dataget
Cost Data
    Get cost datagetGet cost forecastgetGet cost summaryget
Costs
    Get cost datagetGet cost forecastgetGet cost summaryget
Cost Alerts
    List cost alertsgetCreate cost alertpostGet cost alertgetUpdate cost alertputDelete cost alertdeleteGet cost alert eventsgetPause cost alertpostResume cost alertpost
Cost-Alerts
    List cost alertsgetCreate cost alertpostGet cost alertgetUpdate cost alertputDelete cost alertdeleteGet cost alert eventsgetPause cost alertpostResume cost alertpost
Contracting
    Get the data processing agreement statusget
Budgets
    List budgetsgetCreate budgetpostGet budgetgetUpdate budgetputDelete budgetdelete
Billing
    Get the account's entitlementgetGet the account's metered usageget
Entitlement
    Get the account's entitlementget
Usage
    Get the account's metered usageget
Anomalies
    Acknowledge anomalypostList anomaliesget
Allocation
    List allocation rulesgetCreate an allocation rulepostUpdate an allocation ruleputDelete an allocation ruledeleteReorder the allocation rule setpostRead allocation coveragegetList segmentsgetCreate a segmentpostUpdate a segmentputDelete a segmentdeletePreview an allocation rulepost
Segments
    List segmentsgetCreate a segmentpostUpdate a segmentputDelete a segmentdelete
Schemas
Costfluent Public API
Costfluent Public API

Saved-Filters

Server
Download schema

List saved filters

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

Returns all saved filters for a workspace

List saved filters › query Parameters

​CostfluentSharedKernelPublicIdsWorkspacePublicId · required
page
​integer · int32 · required
limit
​integer · int32 · required

List saved filters › Responses

Success

CostfluentPublicApiModelsV1CommonPaginatedResponseOfSavedFilterResponse
​CostfluentPublicApiModelsV1CommonPaginationLinks · required
​CostfluentPublicApiModelsV1ResponsesSavedFilterResponse[] · required
GET/v1/saved-filters
curl 'https://api.costfluent.com/v1/saved-filters?workspaceId=[object Object]&page=<number>&limit=<number>' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "links": { "self": "self", "first": "first", "prev": "prev", "next": "next", "last": "last" }, "data": [ { "id": { "Value": "Value" }, "title": "title", "filter": "filter", "isDefault": true, "createdAt": "2024-08-25T15:00:00Z" } ] }
json
application/json

Create saved filter

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

Creates a reusable filter configuration

Create saved filter › Request Body

CostfluentPublicApiModelsV1RequestsCreateSavedFilterRequest
​CostfluentSharedKernelPublicIdsWorkspacePublicId · minLength: 1 · required
title
​string · minLength: 0 · maxLength: 200 · required
filter
​string · minLength: 0 · maxLength: 4000 · required
isDefault
​boolean

Create saved filter › Responses

Success

CostfluentPublicApiModelsV1ResponsesSavedFilterCreatedResponse
​CostfluentSharedKernelPublicIdsSavedFilterPublicId · required
title
​string · required
POST/v1/saved-filters
curl https://api.costfluent.com/v1/saved-filters \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "workspaceId": { "Value": "Value" }, "title": "title", "filter": "filter", "isDefault": true }'
Example Request Body
{ "workspaceId": { "Value": "Value" }, "title": "title", "filter": "filter", "isDefault": true }
json
Example Responses
{ "id": { "Value": "Value" }, "title": "title" }
json
application/json

Get saved filter

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

Returns a specific saved filter

Get saved filter › path Parameters

​CostfluentSharedKernelPublicIdsSavedFilterPublicId · required

Get saved filter › query Parameters

​CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Get saved filter › Responses

Success

CostfluentPublicApiModelsV1ResponsesSavedFilterResponse
​CostfluentSharedKernelPublicIdsSavedFilterPublicId · required
title
​string · required
filter
​string · required
isDefault
​boolean
createdAt
​string · date-time
GET/v1/saved-filters/{filterId}
curl 'https://api.costfluent.com/v1/saved-filters/:filterId?workspaceId=[object Object]' \ --header 'Authorization: Bearer <token>'
Example Responses
{ "id": { "Value": "Value" }, "title": "title", "filter": "filter", "isDefault": true, "createdAt": "2024-08-25T15:00:00Z" }
json
application/json

Update saved filter

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

Updates a saved filter

Update saved filter › path Parameters

​CostfluentSharedKernelPublicIdsSavedFilterPublicId · required

Update saved filter › query Parameters

​CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Update saved filter › Request Body

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

Update saved filter › Responses

Success

CostfluentPublicApiModelsV1ResponsesSavedFilterResponse
​CostfluentSharedKernelPublicIdsSavedFilterPublicId · required
title
​string · required
filter
​string · required
isDefault
​boolean
createdAt
​string · date-time
PUT/v1/saved-filters/{filterId}
curl 'https://api.costfluent.com/v1/saved-filters/:filterId?workspaceId=[object Object]' \ --request PUT \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "title": "title", "filter": "filter", "isDefault": true }'
Example Request Body
{ "title": "title", "filter": "filter", "isDefault": true }
json
Example Responses
{ "id": { "Value": "Value" }, "title": "title", "filter": "filter", "isDefault": true, "createdAt": "2024-08-25T15:00:00Z" }
json
application/json

Delete saved filter

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

Deletes a saved filter

Delete saved filter › path Parameters

​CostfluentSharedKernelPublicIdsSavedFilterPublicId · required

Delete saved filter › query Parameters

​CostfluentSharedKernelPublicIdsWorkspacePublicId · required

Delete saved filter › Responses

No Content

No data returned
DELETE/v1/saved-filters/{filterId}
curl 'https://api.costfluent.com/v1/saved-filters/:filterId?workspaceId=[object Object]' \ --request DELETE \ --header 'Authorization: Bearer <token>'
Example Responses
No example specified for this content type

Saved FiltersProviders