metrics_details_by_metric
Retrieves detailed license events for a chosen sales metric (churn, conversion, or renewal). Filter by product, hosting, partner type, date range, and more to inspect underlying transaction data.
Instructions
License-event details underlying a sale metric. Returns events[] rows: {addonKey, addonName, hosting, lastUpdated, eventDate, transactionId, licenseDetails, productId}. Supports rich filters (addon, hosting, partnerType, text, sortBy, order, offset, limit). Server caps limit at 50.
📖 Spec (GET /rest/3/reporting/developer-space/{developerId}/sales/metrics/{saleMetric}/details): https://developer.atlassian.com/platform/marketplace/rest/v4/api-group-reporting/#api-rest-3-reporting-developer-space-developerid-sales-metrics-salemetric-details-get
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | No | Free-text search across event identifiers (SEN / appEntitlementNumber, transactionId, customer email, etc). Verified to narrow correctly. | |
| addon | No | App key (e.g. `com.example.your-app`). Undocumented but works as an app filter. Prefer `productId`. | |
| limit | No | Max 50 (server hard-cap; values above are clamped to 50). | |
| order | No | Sort direction. **`asc` works; `desc` is unreliable on this endpoint** — Atlassian returns a non-monotonic ordering for `order=desc` (verified 2026-06-03). With no `sortBy`, `order` is ignored entirely. Prefer `sortBy=date&order=asc` and reverse client-side if you need descending. | |
| offset | No | ||
| sortBy | No | Sort field. Allowed per Atlassian: `addonName`, `date`, `hosting`, `transactionId`, `licenseId`. Anything else → HTTP 400. Only meaningful combined with `order=asc` (see `order`). | |
| endDate | No | ISO date YYYY-MM-DD (filters by eventDate). | |
| hosting | No | Filter events by hosting. Response objects use capitalized 'Cloud'/'Server'/'Data Center'. | |
| productId | No | Product UUID — narrows events to one app (documented + verified 2026-06-03; all returned rows match). | |
| startDate | No | ISO date YYYY-MM-DD (filters by eventDate). | |
| appEdition | No | Filter by app edition (free/standard/advanced). | |
| saleMetric | Yes | Which underlying metric's events to fetch. | |
| lastUpdated | No | ISO date YYYY-MM-DD — events whose lastUpdated is on/after this date. Verified to narrow correctly. | |
| partnerType | No | Filter by partner attribution channel: `direct`, `expert`, `reseller`. NOTE: Atlassian's error message also lists `upgrade` as allowable, but passing it returns HTTP 400 (Atlassian-side contradiction, verified 2026-06-03) — so it's excluded here. |