metrics_churn_benchmark
Compare your app's monthly churn rate against the ecosystem average. Filter by app key or product ID and date range to get normalized benchmark ratios per month.
Instructions
Per-app monthly churn benchmark vs. ecosystem average. Returns churnBenchmarkPerApp[] where each entry has churnBenchmarkPerMonth[] rows: {year, month, churnedLicenses, totalLicenses, churnRate, isolatedChurnRate, churnRateBenchmark, isolatedChurnRateBenchmark}. The *Benchmark fields are normalized so 1.0 ≈ ecosystem average. Filter by addon (app key) or productId (UUID). Note: data has a ~2-3 month publication lag. Default (no filter) returns full history for all apps — large response (~60KB) triggers the truncation envelope. Use date range to narrow.
📖 Spec (GET /rest/3/reporting/developer-space/{developerId}/sales/metrics/churn/benchmark): https://developer.atlassian.com/platform/marketplace/rest/v4/api-group-reporting/#api-rest-3-reporting-developer-space-developerid-sales-metrics-churn-benchmark-get
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| addon | No | App key (e.g. `com.example.your-app` — NOT productId UUID). Single value via this MCP. Silently ignored if `productId` is also passed. | |
| endDate | No | ISO date YYYY-MM-DD. Note: data has a ~2-3 month publication lag; very recent windows can return empty `churnBenchmarkPerApp[]`. | |
| productId | No | Product UUID. Single value. Not documented in Atlassian's HAL query template but works as a real filter. When BOTH `addon` and `productId` are passed, `productId` wins. Invalid or non-matching UUIDs are silently ignored (full list returned). | |
| startDate | No | ISO date YYYY-MM-DD. Trims `churnBenchmarkPerMonth[]` to months overlapping the window. |