Customer value report
Generates a customer value report with flexible grouping and metric calculations.
Query parameters
Field to group results by.
Available fields: createdAt, currency, product.name, price.name, attribution.utmSource, attribution.utmCampaign
Date granularity for groupBy when it is a date field. Defaults to day. hour additionally requires the query to be bounded to a createdAt range of at most two days. Accepts hour, day, week, month, quarter, year; anything else falls back to the default.
Optional second axis for pivoting (must differ from groupBy). Each row will then carry both the primary groupBy value and a secondaryGroupBy value.
Available fields: createdAt, currency, product.name, price.name, attribution.utmSource, attribution.utmCampaign
Date granularity for secondaryGroupBy when it is a date field. Defaults to day.
Metrics to include in the results. Multiple measures can be specified as comma-separated values. If measures is not provided, all metrics specified in the config will be calculated.
Available metrics: fcQuantity, fcAmount, fcAov, upsellsQuantity, upsellsItemsCount, upsellsAmount, upsellsAov, totalAov, rebillsQuantity, rebillsItemsCount, rebillsAmount, ltv
Whether to include a rollup row aggregating every group. Pass false to omit it.
Response
OK
Example response
{
"data": [
{
"groupBy": "USD",
"secondaryGroupBy": "eur",
"fcQuantity": 150,
"fcAmount": 30000,
"fcAov": 200,
"upsellsQuantity": 45,
"upsellsItemsCount": 72,
"upsellsAmount": 9000,
"upsellsAov": 200,
"totalAov": 260,
"rebillsQuantity": 300,
"rebillsItemsCount": 480,
"rebillsAmount": 60000,
"ltv": 660
}
],
"total": {
"groupBy": "USD",
"secondaryGroupBy": "eur",
"fcQuantity": 150,
"fcAmount": 30000,
"fcAov": 200,
"upsellsQuantity": 45,
"upsellsItemsCount": 72,
"upsellsAmount": 9000,
"upsellsAov": 200,
"totalAov": 260,
"rebillsQuantity": 300,
"rebillsItemsCount": 480,
"rebillsAmount": 60000,
"ltv": 660
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.