Costs

Get combined revenue and cost analytics

Changed on

Use when building dashboards or reports that need revenue vs cost, ROI, and margin over a time period (e.g. finance views or executive summaries).

post/costs/analytics

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/costs/analytics
  • Auth
    API key in header x-api-key

Request body

end_timestring date-time
expandstring[]

Expand options - specify which entities to expand

external_customer_idstring

Optional - for specific customer

feature_idsstring[]

Additional filters

include_childrenboolean

IncludeChildren, when true and ExternalCustomerID belongs to a parent customer, aggregates every inherited-child customer's usage into the revenue and cost totals. Default (false) restricts the query to the customer's own usage — mirrors the meter-usage analytics contract.

limitinteger

Pagination

offsetinteger
property_filtersobject

Property filters to filter the events by the keys in properties field of the event

start_timestring date-time

Time range fields (optional - defaults to last 7 days if not provided)

Response

OK

currencystring
end_timestring date-time
marginstring

Revenue - Cost

margin_percentstring

(Margin / Revenue) * 100

roistring

(Revenue - Cost) / Cost

roi_percentstring

ROI * 100

start_timestring date-time
total_coststring
total_revenuestring

Derived metrics

Changes

  • e1d4e27b5677Revision changes
    • info

      added the optional property /// to the response with the status

  • 50b7421a9690Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property