---
title: "Get combined revenue and cost analytics (V2)"
method: POST
path: "/costs/analytics-v2"
tags: ["Costs"]
---

# Get combined revenue and cost analytics (V2)

`POST /costs/analytics-v2`

Use when you need the same revenue/cost/ROI analytics but computed from the costsheet usage-tracking pipeline (e.g. for consistency with usage-based cost data).

## Request body

- GetCostAnalyticsRequest
  - `end_time` string, date-time
  - `expand` string[] — Expand options - specify which entities to expand
  - `external_customer_id` string — Optional - for specific customer
  - `feature_ids` string[] — Additional filters
  - `include_children` boolean — 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.
  - `limit` integer — Pagination
  - `offset` integer
  - `property_filters` object — Property filters to filter the events by the keys in `properties` field of the event
  - `start_time` string, date-time — Time range fields (optional - defaults to last 7 days if not provided)

## Response `200`

OK

- GetDetailedCostAnalyticsResponse
  - `cost_analytics` CostAnalyticItem[] — Cost analytics array (flattened from nested structure)
    - `cost_by_period` CostPoint[] — Breakdown
      - `cost` string
      - `event_count` integer
      - `quantity` string
      - `timestamp` string
    - `costsheet_id` string
    - `currency` string — Metadata
    - `customer_id` string
    - `external_customer_id` string
    - `meter` MeterMeter
      - `aggregation` MeterAggregation
        - `bucket_size` 'MINUTE' | '15MIN' | '30MIN' | 'HOUR' | '3HOUR' | '6HOUR' | '12HOUR' | 'DAY' | 'WEEK' | 'MONTH'
        - `expression` string — Expression is an optional CEL expression to compute per-event quantity from event.properties. When set, it replaces Field-based extraction. Property names are used directly (e.g., token * duration * pixel).
        - `field` string — Field is the key in $event.properties on which the aggregation is to be applied For ex if the aggregation type is sum for API usage, the field could be "duration_ms" Ignored when Expression is set.
        - `group_by` string — GroupBy is the property name in event.properties to group by before aggregating. Currently only supported for MAX aggregation with bucket_size. When set, aggregation is applied per unique value of this property within each bucket, then the per-group results are summed to produce the bucket total.
        - `multiplier` string — Multiplier is the multiplier for the aggregation For ex if the aggregation type is sum_with_multiplier for API usage, the multiplier could be 1000 to scale up by a factor of 1000. If not provided, it will be null.
        - `type` 'COUNT' | 'SUM' | 'AVG' | 'COUNT_UNIQUE' | 'LATEST' | 'SUM_WITH_MULTIPLIER' | 'MAX' | 'WEIGHTED_SUM'
      - `created_at` string, date-time
      - `created_by` string
      - `environment_id` string — EnvironmentID is the environment identifier for the meter
      - `event_name` string — EventName is the unique identifier for the event that this meter is tracking It is a mandatory field in the events table and hence being used as the primary matching field We can have multiple meters tracking the same event but with different filters and aggregation
      - `filters` MeterFilter[] — Filters define the criteria for the meter to be applied on the events before aggregation It also defines the possible values on which later the charges will be applied
        - `key` string — Key is the key for the filter from $event.properties Currently we support only first level keys in the properties and not nested keys
        - `values` string[] — Values are the possible values for the filter to be considered for the meter For ex "model_name" could have values "o1-mini", "gpt-4o" etc
      - `id` string — ID is the unique identifier for the meter
      - `name` string — Name is the display name of the meter
      - `reset_usage` 'BILLING_PERIOD' | 'NEVER'
      - `status` 'published' | 'deleted' | 'archived'
      - `tenant_id` string
      - `updated_at` string, date-time
      - `updated_by` string
    - `meter_id` string
    - `meter_name` string
    - `price` PricePrice
      - `amount` string — Amount stored in main currency units (e.g., dollars, not cents) For USD: 12.50 means $12.50
      - `billing_cadence` 'RECURRING'
      - `billing_model` 'FLAT_FEE' | 'PACKAGE' | 'TIERED'
      - `billing_period` 'MONTHLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY' | 'QUARTERLY' | 'HALF_YEARLY' | 'ONETIME'
      - `billing_period_count` integer — BillingPeriodCount is the count of the billing period ex 1, 3, 6, 12
      - `conversion_rate` string — ConversionRate is the conversion rate of the price unit to the fiat currency
      - `created_at` string, date-time
      - `created_by` string
      - `currency` string — Currency 3 digit ISO currency code in lowercase ex usd, eur, gbp
      - `description` string — Description of the price
      - `display_amount` string — DisplayAmount is the formatted amount with currency symbol For USD: $12.50
      - `display_name` string — DisplayName is the name of the price
      - `display_price_unit_amount` string — DisplayPriceUnitAmount is the formatted amount of the price unit
      - `end_date` string, date-time — EndDate is the end date of the price
      - `entity_id` string — EntityID holds the value of the "entity_id" field.
      - `entity_type` 'PLAN' | 'SUBSCRIPTION' | 'ADDON' | 'PRICE' | 'COSTSHEET'
      - `environment_id` string — EnvironmentID is the environment identifier for the price
      - `group_id` string — GroupID references the group this price belongs to
      - `id` string — ID uuid identifier for the price
      - `invoice_cadence` 'ARREAR' | 'ADVANCE'
      - `lookup_key` string — LookupKey used for looking up the price in the database
      - `metadata` PriceJSONBMetadata
      - `meter_id` string — MeterID is the id of the meter for usage based pricing
      - `min_quantity` string, nullable — MinQuantity is the minimum quantity of the price
      - `parent_price_id` string — ParentPriceID references the root price (always set for price lineage tracking)
      - `price_unit` string — PriceUnit is the code of the price unit (e.g., 'btc', 'eth')
      - `price_unit_amount` string — PriceUnitAmount is the amount of the price unit
      - `price_unit_id` string — PriceUnitID is the id of the price unit (for CUSTOM type)
      - `price_unit_tiers` PricePriceTier[] — PriceUnitTiers are the tiers for the price unit when BillingModel is TIERED
        - `flat_amount` string — flat_amount is the flat amount for the given tier (optional) Applied on top of unit_amount*quantity. Useful for cases like "2.7$ + 5c"
        - `unit_amount` string — unit_amount is the amount per unit for the given tier
        - `up_to` integer — up_to is the quantity up to which this tier applies. It is null for the last tier. IMPORTANT: Tier boundaries are INCLUSIVE. - If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier - This behavior is consistent across both VOLUME and SLAB tier modes
      - `price_unit_type` 'FIAT' | 'CUSTOM'
      - `sequence` integer — Sequence is the monotonic stamp bumped on every state change that subscription line items need to react to. Read by the plan-price sync; set by the database (DEFAULT nextval) on create and by the price repository on termination / compatibility-affecting edits.
      - `start_date` string, date-time — StartDate is the start date of the price
      - `status` 'published' | 'deleted' | 'archived'
      - `tenant_id` string
      - `tier_mode` 'VOLUME' | 'SLAB'
      - `tiers` PricePriceTier[]
        - `flat_amount` string — flat_amount is the flat amount for the given tier (optional) Applied on top of unit_amount*quantity. Useful for cases like "2.7$ + 5c"
        - `unit_amount` string — unit_amount is the amount per unit for the given tier
        - `up_to` integer — up_to is the quantity up to which this tier applies. It is null for the last tier. IMPORTANT: Tier boundaries are INCLUSIVE. - If up_to is 1000, then quantity less than or equal to 1000 belongs to this tier - This behavior is consistent across both VOLUME and SLAB tier modes
      - `transform_quantity` PriceJSONBTransformQuantity
        - `divide_by` integer — Divide quantity by this number
        - `round` 'up' | 'down'
      - `trial_period_days` integer — TrialPeriodDays is the number of days for the trial period Note: This is only applicable for recurring prices (BILLING_CADENCE_RECURRING)
      - `type` 'USAGE' | 'FIXED'
      - `updated_at` string, date-time
      - `updated_by` string
    - `price_id` string
    - `properties` object
    - `source` string
    - `total_cost` string — Aggregated metrics
    - `total_events` integer
    - `total_quantity` string
  - `currency` string
  - `end_time` string, date-time
  - `margin` string — Revenue - Cost
  - `margin_percent` string — (Margin / Revenue) * 100
  - `roi` string — (Revenue - Cost) / Cost
  - `roi_percent` string — ROI * 100
  - `start_time` string, date-time
  - `total_cost` string
  - `total_revenue` string — Derived metrics

## Other responses

- `400` — Invalid request
- `500` — Server error

---

[API](https://skmtc.net/flexprice/apis/flexprice-api.md) · [All operations](https://skmtc.net/flexprice/apis/flexprice-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flexprice/flexprice-api/versions/f0601ed97bd3/schema)