Costfluent Public API
​WorkspacePublicId · pattern: ​integer · int32 · required​integer · int32 · required
​WorkspacePublicId · pattern: ​string · required​string · required​array | null​BusinessMetricPublicId · pattern: ​string · required​string · required​string[] · required​string · date-time​string | null · date-time
​BusinessMetricPublicId · pattern: ​WorkspacePublicId · pattern: ​BusinessMetricPublicId · pattern: ​string · required​string · required​string[] · required​string · date-time​string | null · date-time
​BusinessMetricPublicId · pattern: ​WorkspacePublicId · pattern: ​BusinessMetricPublicId · pattern: ​string · required​string · required​string[] · required​string · date-time​string | null · date-time
​BusinessMetricPublicId · pattern: ​WorkspacePublicId · pattern:
​BusinessMetricPublicId · pattern: ​WorkspacePublicId · pattern: ​integer · int32 · required​integer · int32 · required​string | null · date​string | null · date
​BusinessMetricPublicId · pattern: ​WorkspacePublicId · pattern: ​integer · int32 · required​integer · int32 · required​integer · int32 · required
Business Metrics
List business metrics
GET
https://api.costfluent.com
/v1/business-metrics
Bearer (API token)
Returns a workspace's business metrics
query Parameters
workspaceId^wsp_[A-Za-z0-9_-]{2… · requiredpagelimitList business metrics › Responses
Success
​PaginationLinks · required
​BusinessMetricResponse[] · required
Create business metric
POST
https://api.costfluent.com
/v1/business-metrics
Bearer (API token)
Creates a business metric whose daily values a cost report divides cost by
Create business metric › Request Body
workspaceId^wsp_[A-Za-z0-9_-]{2… · requirednameunitlabelColumnsCreate business metric › Responses
Created
id^bmt_[A-Za-z0-9_-]{2… · requirednameunitlabelColumnscreatedAtupdatedAtGet business metric
GET
https://api.costfluent.com
/v1/business-metrics/{metricId}
Bearer (API token)
Returns one business metric
path Parameters
metricId^bmt_[A-Za-z0-9_-]{2… · requiredquery Parameters
workspaceId^wsp_[A-Za-z0-9_-]{2… · requiredGet business metric › Responses
Success
id^bmt_[A-Za-z0-9_-]{2… · requirednameunitlabelColumnscreatedAtupdatedAtUpdate business metric
PUT
https://api.costfluent.com
/v1/business-metrics/{metricId}
Bearer (API token)
Renames a business metric or its unit; its label columns stay
path Parameters
metricId^bmt_[A-Za-z0-9_-]{2… · requiredquery Parameters
workspaceId^wsp_[A-Za-z0-9_-]{2… · requiredUpdate business metric › Responses
Success
id^bmt_[A-Za-z0-9_-]{2… · requirednameunitlabelColumnscreatedAtupdatedAtDelete business metric
DELETE
https://api.costfluent.com
/v1/business-metrics/{metricId}
Bearer (API token)
Deletes a business metric and its values; a report charting its unit cost goes back to cost alone
path Parameters
metricId^bmt_[A-Za-z0-9_-]{2… · requiredquery Parameters
workspaceId^wsp_[A-Za-z0-9_-]{2… · requiredDelete business metric › Responses
No Content
No data returned
List business metric values
GET
https://api.costfluent.com
/v1/business-metrics/{metricId}/values
Bearer (API token)
Returns a business metric's values between two days, both included, by day
path Parameters
metricId^bmt_[A-Za-z0-9_-]{2… · requiredquery Parameters
workspaceId^wsp_[A-Za-z0-9_-]{2… · requiredpagelimitfromtoList business metric values › Responses
Success
​PaginationLinks · required
​BusinessMetricValueResponse[] · required
Import business metric values
POST
https://api.costfluent.com
/v1/business-metrics/{metricId}/values
Bearer (API token)
Stores dated values, each replacing the amount the metric holds for its day and labels, so a repeated request changes nothing
path Parameters
metricId^bmt_[A-Za-z0-9_-]{2… · requiredquery Parameters
workspaceId^wsp_[A-Za-z0-9_-]{2… · requiredImport business metric values › Responses
Success
createdupdatedunchanged