metrics_renewal
Get time-series data of cloud renewal opportunities and renewals, segmented by monthly and annual billing periods, to compute renewal rates.
Instructions
Cloud renewal TIME-SERIES. total.datasets[] split by billing period (Annual, Monthly) — like churn — with two series each: Renewal opportunities (denominator) and Renewals (numerator). NOTE: unlike churn, renewal series have NO uniqueTotal field (each series is just {name, elements:[{date,count}]}). addons[] carry datasets. Caller computes renewal rate = Renewals / Renewal opportunities per bucket. Only aggregation/startDate/endDate work; other filters silently ignored. Reversed/future ranges return empty datasets+addons.
📖 Spec (GET /rest/3/reporting/developer-space/{developerId}/sales/metrics/renewal): https://developer.atlassian.com/platform/marketplace/rest/v4/api-group-reporting/#api-rest-3-reporting-developer-space-developerid-sales-metrics-renewal-get
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| endDate | No | ISO date YYYY-MM-DD (inclusive upper bound). | |
| startDate | No | ISO date YYYY-MM-DD (inclusive lower bound). | |
| aggregation | No | Time-series bucket cadence. Default: week. Affects the number of `elements[]` returned per series. |