Guide
Metric Dictionary
Compare product revenue, customer payments, email engagement, sessions, earnings, and payout eligibility using consistent definitions.
SoundSync
Read revenue, earnings, and payouts separately
| Measure | Meaning |
|---|---|
| Gross product revenue | Product value before discounts and tax; not the total charged to the customer. |
| Net product revenue | Product value after discounts and product-level adjustments, excluding tax. |
| Customer payment volume | Customer payments including applicable tax; keep it separate from product revenue. |
| Developer earnings | The developer allocation after the SoundSync fee, applicable accepted shares, and recorded adjustments. |
| Eligible payout balance | Funded, unpaid earnings that have cleared the hold and account checks; not every sale in a date range. |
| External-sale estimates | Imported or partner-reported amounts are not automatically collected or payable SoundSync funds. |
SoundSync
Activity and engagement
| Metric | Interpretation |
|---|---|
| Orders and initial conversion | Use the selected completed-order scope; automatic subscription renewals do not count as new initial checkouts. |
| Session | A visit grouped by a 30-minute inactivity boundary, not each page event. |
| Returning visitor | A returning visitor identity, not the number of repeated events. |
| Email open/click rate | Unique message engagement over the delivered-message denominator in the corresponding scope. Tracking gaps can affect observations. |
| Marketing allowance | A separate calendar-month usage allowance; selecting several months does not make one combined allowance. |
| Downloads / activations | Recorded authorized delivery or device-use events; not a count of all people who own a product. |
| Unavailable history | A metric without the necessary historic data is unavailable, not a verified zero. |
Country is a recorded attribute
Customer country can come from billing, a saved profile, a serial claim, or an available approximate observation, in that order of preference. Known countries, Other, and Unknown are different report groups. A purchasing-customer filter is not the same population as all contacts.
Automatic IP-to-country inference is not currently configured. Do not interpret Unknown as a particular country, or the report as GPS tracking. Developer-configured GA4 is a separate optional integration, not a SoundSync customer-geography feed.
SoundSync
Compare with the payment record
Read Growth Flow reporting in the selected range
Choose a day window or All time. GET /api/developer/marketing/growth-flows/summary?range=all returns range:"all" and rangeDays:null. A bounded report returns range:"days" and an integer rangeDays; the default is 30 days. The list endpoint also accepts range=all. The ordinary flow list hides archived flows.
Archiving stops a flow from appearing in the ordinary list without erasing its history. Summary totals include archived activity; totalFlows includes that history, while activeFlows counts active entries. archivedFlows and archivedActivity identify the archived contribution. Do not expect summing only the visible flow cards to reproduce every historical total.
emailsSent, conversions and revenue use the selected reporting window. queuedNow, sentTotal, failedTotal and unresolvedTotal are current queue-lifecycle snapshots, with queueSnapshotAt showing when they were read. They are not alternative names for the ranged send count.
Attributed sales are not payout earnings
Marketing revenue uses attributable net product revenue from the canonical sale records: product subtotal less discounts, product refunds, chargebacks and dispute adjustments, excluding tax. Keep live and test scope aligned. Imported, administrative and migration-only rows are not funded managed-sale revenue. Provider event amounts are not the financial source of truth.
Direct campaign or flow attribution and supported click-to-purchase attribution are different evidence paths; the click path uses a fourteen-day window. This associates a recorded sale with marketing activity, not proof the message caused it. Counts are deduplicated at the reporting level; flow, campaign and whole-workspace totals are not automatically additive.
Campaign recipient reports use actual recipient rows once sending is finalized rather than an earlier audience estimate. Queue/provider reconciliation avoids treating one send as separate queued and sent messages. Acceptance is not proof of inbox delivery, and privacy features can affect observed opens and clicks.
SoundSync
Read providerStatsStatus before interpreting a zero
| Status | What the report knows |
|---|---|
| not_sent | No sends for this report; no provider-history conclusion is implied. |
| pending | No usable provider snapshot yet. Pending sync is not a confirmed zero. |
| retrying | Provider lookup failed without a usable snapshot. Known events remain while sync retries; no completion deadline is promised. |
| ready | A usable provider snapshot is available. providerStatsCheckedAt identifies the observation, not inbox certainty or payout revenue. |
| stale | Last usable provider totals remain after a newer lookup failure. These are last-known values, not current confirmed totals. Inspect providerStatsError. |
| unavailable | Provider channel/history is unavailable without a usable snapshot. History unavailable is not zero delivery/engagement or a promise that future sync can recover it. Recorded events and attributed sales remain. |
Keep partial totals separate from delivery failures
delivered, providerBounced, providerUnsubscribed and providerComplaints can be null. Do not replace null with zero. performanceSource distinguishes elastic_channel from recorded_events; recordedOpenEvents and recordedClickEvents remain independent of a provider snapshot.
Recorded deliveries counts saved, matched delivery receipts when a complete provider total is unavailable; Report details explains coverage. Do not treat that incomplete count as total delivery or add it to the same campaign provider total. Rates use delivered messages when available, otherwise sent messages, never the incomplete receipt count; inspect engagementDenominator and availability. Detail report openRate/clickRate are raw ratios. Campaign list reports use {percent,status} rate objects. The UI can show Pending sync, History unavailable, Not tracked or Awaiting consistent data instead of a percentage.
Unavailable history is not a failed recipient and must not cause a resend. Preserve accepted sends, consent/suppression rules, known events and attributed net sales. Guarded delivery review/retries concern supported recipient states, not missing analytics. Open/click measurements are not proof of inbox placement or permission to send.
SoundSync
Delivery evidence in campaign reports
| Field | Interpretation |
|---|---|
| delivered | Complete provider-channel delivery total when available; null means unavailable, not zero. |
| recordedDelivered | Count of saved, matched individual delivery receipts. This can be incomplete; zero does not prove no delivery. |
| deliverySource: provider_channel | Use the complete provider total for that campaign; do not add its receipt count again. |
| deliverySource: recorded_receipts | Only individually recorded delivery evidence is available; do not present it as the full campaign total. |
| deliverySource: not_sent / unavailable | No sends yet / no usable delivery evidence. Read providerStatsStatus separately for sync availability. |
| lastDeliveryAt | Latest matched receipt timestamp where available, otherwise null. It is not the time of a new provider lookup. |
| performanceSource | elastic_channel or recorded_events describes broader performance data; it is separate from deliverySource. |
Read coverage before comparing campaigns
Campaign reporting uses saved provider snapshots and recorded events. Delivery receipts are matched to the developer, campaign and recipient using provider identifiers and timing; provider acceptance, opens and clicks do not count as delivery receipts.
Recorded deliveries and Report details make incomplete coverage visible. Across campaigns, use provider totals where available and receipt evidence only for campaigns without a complete provider total. Never double-count both sources for one campaign or relabel a partial aggregate as complete.
Open/click rate denominators use complete delivered totals when available, otherwise sent counts. They never use incomplete recordedDelivered counts. Reporting reads do not send emails, fetch provider history or change recipients, consent, usage charges or financial records. Missing history is not a reason to retry delivery.
SoundSync