Retrieve combined analytics with ROI, margin, and detailed breakdowns. If start_time and end_time are not provided, defaults to last 7 days.
curl --request POST \
--url https://api.cloud.flexprice.io/v1/costs/analytics-v2 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"end_time": "<string>",
"expand": [
"<string>"
],
"external_customer_id": "<string>",
"feature_ids": [
"<string>"
],
"limit": 123,
"offset": 123,
"start_time": "<string>"
}
'{
"cost_analytics": [
{
"cost_by_period": [
{
"cost": "<string>",
"event_count": 123,
"quantity": "<string>",
"timestamp": "<string>"
}
],
"costsheet_id": "<string>",
"currency": "<string>",
"customer_id": "<string>",
"external_customer_id": "<string>",
"meter": {
"aggregation": {
"bucket_size": "MINUTE",
"field": "<string>",
"multiplier": "<string>",
"type": "COUNT"
},
"created_at": "<string>",
"created_by": "<string>",
"environment_id": "<string>",
"event_name": "<string>",
"filters": [
{
"key": "<string>",
"values": [
"<string>"
]
}
],
"id": "<string>",
"name": "<string>",
"reset_usage": "BILLING_PERIOD",
"status": "published",
"tenant_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>"
},
"meter_id": "<string>",
"meter_name": "<string>",
"price": {
"amount": "<string>",
"billing_cadence": "RECURRING",
"billing_model": "FLAT_FEE",
"billing_period": "MONTHLY",
"billing_period_count": 123,
"conversion_rate": "<string>",
"created_at": "<string>",
"created_by": "<string>",
"currency": "<string>",
"description": "<string>",
"display_amount": "<string>",
"display_name": "<string>",
"display_price_unit_amount": "<string>",
"end_date": "<string>",
"entity_id": "<string>",
"entity_type": "PLAN",
"environment_id": "<string>",
"group_id": "<string>",
"id": "<string>",
"invoice_cadence": "ARREAR",
"lookup_key": "<string>",
"metadata": {},
"meter_id": "<string>",
"min_quantity": "<string>",
"parent_price_id": "<string>",
"price_unit": "<string>",
"price_unit_amount": "<string>",
"price_unit_id": "<string>",
"price_unit_tiers": [
{
"flat_amount": "<string>",
"unit_amount": "<string>",
"up_to": 123
}
],
"price_unit_type": "FIAT",
"start_date": "<string>",
"status": "published",
"tenant_id": "<string>",
"tier_mode": "VOLUME",
"tiers": [
{
"flat_amount": "<string>",
"unit_amount": "<string>",
"up_to": 123
}
],
"transform_quantity": {
"divide_by": 123,
"round": "up"
},
"trial_period": 123,
"type": "USAGE",
"updated_at": "<string>",
"updated_by": "<string>"
},
"price_id": "<string>",
"properties": {},
"source": "<string>",
"total_cost": "<string>",
"total_events": 123,
"total_quantity": "<string>"
}
],
"currency": "<string>",
"end_time": "<string>",
"margin": "<string>",
"margin_percent": "<string>",
"roi": "<string>",
"roi_percent": "<string>",
"start_time": "<string>",
"total_cost": "<string>",
"total_revenue": "<string>"
}Enter your API key in the format x-api-key <api-key>*
Combined analytics request (start_time/end_time optional - defaults to last 7 days)
Expand options - specify which entities to expand
Optional - for specific customer
Additional filters
Pagination
Time range fields (optional - defaults to last 7 days if not provided)
OK
Cost analytics array (flattened from nested structure)
Show child attributes
Revenue - Cost
(Margin / Revenue) * 100
(Revenue - Cost) / Cost
ROI * 100
Derived metrics
curl --request POST \
--url https://api.cloud.flexprice.io/v1/costs/analytics-v2 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"end_time": "<string>",
"expand": [
"<string>"
],
"external_customer_id": "<string>",
"feature_ids": [
"<string>"
],
"limit": 123,
"offset": 123,
"start_time": "<string>"
}
'{
"cost_analytics": [
{
"cost_by_period": [
{
"cost": "<string>",
"event_count": 123,
"quantity": "<string>",
"timestamp": "<string>"
}
],
"costsheet_id": "<string>",
"currency": "<string>",
"customer_id": "<string>",
"external_customer_id": "<string>",
"meter": {
"aggregation": {
"bucket_size": "MINUTE",
"field": "<string>",
"multiplier": "<string>",
"type": "COUNT"
},
"created_at": "<string>",
"created_by": "<string>",
"environment_id": "<string>",
"event_name": "<string>",
"filters": [
{
"key": "<string>",
"values": [
"<string>"
]
}
],
"id": "<string>",
"name": "<string>",
"reset_usage": "BILLING_PERIOD",
"status": "published",
"tenant_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>"
},
"meter_id": "<string>",
"meter_name": "<string>",
"price": {
"amount": "<string>",
"billing_cadence": "RECURRING",
"billing_model": "FLAT_FEE",
"billing_period": "MONTHLY",
"billing_period_count": 123,
"conversion_rate": "<string>",
"created_at": "<string>",
"created_by": "<string>",
"currency": "<string>",
"description": "<string>",
"display_amount": "<string>",
"display_name": "<string>",
"display_price_unit_amount": "<string>",
"end_date": "<string>",
"entity_id": "<string>",
"entity_type": "PLAN",
"environment_id": "<string>",
"group_id": "<string>",
"id": "<string>",
"invoice_cadence": "ARREAR",
"lookup_key": "<string>",
"metadata": {},
"meter_id": "<string>",
"min_quantity": "<string>",
"parent_price_id": "<string>",
"price_unit": "<string>",
"price_unit_amount": "<string>",
"price_unit_id": "<string>",
"price_unit_tiers": [
{
"flat_amount": "<string>",
"unit_amount": "<string>",
"up_to": 123
}
],
"price_unit_type": "FIAT",
"start_date": "<string>",
"status": "published",
"tenant_id": "<string>",
"tier_mode": "VOLUME",
"tiers": [
{
"flat_amount": "<string>",
"unit_amount": "<string>",
"up_to": 123
}
],
"transform_quantity": {
"divide_by": 123,
"round": "up"
},
"trial_period": 123,
"type": "USAGE",
"updated_at": "<string>",
"updated_by": "<string>"
},
"price_id": "<string>",
"properties": {},
"source": "<string>",
"total_cost": "<string>",
"total_events": 123,
"total_quantity": "<string>"
}
],
"currency": "<string>",
"end_time": "<string>",
"margin": "<string>",
"margin_percent": "<string>",
"roi": "<string>",
"roi_percent": "<string>",
"start_time": "<string>",
"total_cost": "<string>",
"total_revenue": "<string>"
}