Use Hourly refresh frequency, add sample data to Readme

reshmabidikar · reshmabidikar · commit 6cfa74cc89f5 · 2025-09-26T15:11:10.000+05:30
diff --git a/reports/active_by_product_term_monthly/README.md b/reports/active_by_product_term_monthly/README.md
@@ -18,9 +18,23 @@ curl -v \
           "reportPrettyName": "Monthly Active Subscriptions by Product Term",
           "sourceTableName": "report_active_by_product_term_monthly",
           "refreshProcedureName": "refresh_active_by_product_term_monthly",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
+## Sample Data
+
+| tenant_record_id | day        | product_name | billing_period | count |
+|------------------|------------|--------------|----------------|-------|
+| 1                | 2025-08-31 | Gold         | MONTHLY        | 3     |
+| 2                | 2025-08-31 | Gold         | MONTHLY        | 1     |
+| 1                | 2025-08-31 | Gold         | ANNUAL         | 2     |
+| 2                | 2025-09-30 | Silver       | MONTHLY        | 4     |
+| 2                | 2025-09-30 | Gold         | QUARTERLY      | 1     |
+
+The first row in the above table indicates that on `2025-08-31` the `tenant_record_id=1` had 3 Monthly subscriptions for the `Gold` product.
+
+
+
 ## Report UI:
 
 ![monthly-active-subs-by-product-term.png](monthly-active-subs-by-product-term.png)
diff --git a/reports/cancellations_daily/README.md b/reports/cancellations_daily/README.md
@@ -18,9 +18,22 @@ curl -v \
           "reportPrettyName": "Daily Cancellations",
           "sourceTableName": "report_cancellations_daily",
           "refreshProcedureName": "refresh_report_cancellations_daily",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
+## Sample Data
+
+| tenant_record_id | phase     | day        | count |
+|------------------|-----------|------------|-------|
+| 1                | EVERGREEN | 2025-09-10 | 9     |
+| 1                | EVERGREEN | 2025-09-03 | 2     |
+| 1                | EVERGREEN | 2025-09-22 | 5     |
+| 2                | EVERGREEN | 2025-09-23 | 6     |
+| 2                | EVERGREEN | 2025-09-24 | 6     |
+| 1                | EVERGREEN | 2025-09-25 | 1     |
+
+The first row in the above table indicates that on `2025-09-10`, the `tenant_record_id=1` had 9 cancellations in `EVERGREEN` phase.
+
 ## Report UI:
 
 ![daily-cancellations.png](daily-cancellations.png)
diff --git a/reports/chargebacks_daily/README.md b/reports/chargebacks_daily/README.md
@@ -18,6 +18,23 @@ curl -v \
           "reportPrettyName": "Daily Chargebacks Value",
           "sourceTableName": "report_chargebacks_daily",
           "refreshProcedureName": "refresh_report_chargebacks_daily",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
+
+## Sample Data
+
+| tenant_record_id | day        | currency | count    |
+|------------------|------------|----------|----------|
+| 1                | 2025-09-18 | USD      | 100.0000 |
+| 1                | 2025-09-26 | USD      | 50.0000  |
+| 2                | 2025-09-11 | USD      | 100.0000 |
+
+The first row in the above table indicates that on `2025-09-18`, the `tenant_record_id=1` had a total chargeback value of `$100`
+
+
+## Report UI:
+
+![chargebacks-daily.png](chargebacks-daily.png)
+
+
diff --git a/reports/chargebacks_daily/chargebacks-daily.png b/reports/chargebacks_daily/chargebacks-daily.png
diff --git a/reports/conversion-total-dollar-amount/README.md b/reports/conversion-total-dollar-amount/README.md
@@ -18,7 +18,7 @@ curl -v \
           "reportPrettyName": "Conversions Total Dollar Amount",
           "sourceTableName": "report_conversions_total_dollar_monthly",
           "refreshProcedureName": "refresh_report_conversions_total_dollar_monthly",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
@@ -32,7 +32,7 @@ curl -v \
 |6| 2025-01-01 |ANNUAL|200|
 |1| 2025-04-01 |MONTHLY|30|
 
-Here day represents the first day of the month representing that subscription's conversion month. So if the subscription converts from TRIAL to EVERGREEN phase on `2025-04-15`, the day will be `2025-04-01`.
+Here `day` represents the first day of the month representing that subscription's conversion month. So if the subscription converts from TRIAL to EVERGREEN phase on `2025-04-15`, the day will be `2025-04-01`. The first row in the above table means that in the month of June, a revenue of `$30` was generated when `WEEKLY` subscriptions moved out of `TRIAL`.
 
 ## Report UI:
 
diff --git a/reports/invoice_aging/README.md b/reports/invoice_aging/README.md
@@ -22,7 +22,7 @@ curl -v \
           "reportPrettyName": "Invoice Aging Report",
           "sourceTableName": "report_invoice_aging",
           "refreshProcedureName": "refresh_report_invoice_aging",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
diff --git a/reports/invoice_aging_no_payment/README.md b/reports/invoice_aging_no_payment/README.md
@@ -22,7 +22,7 @@ curl -v \
           "reportPrettyName": "Invoice Aging No Payments Report",
           "sourceTableName": "report_invoice_aging_no_payment",
           "refreshProcedureName": "refresh_report_invoice_aging_no_payment",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
diff --git a/reports/invoice_credits_daily/README.md b/reports/invoice_credits_daily/README.md
@@ -20,21 +20,20 @@ curl -v \
           "reportPrettyName": "Invoice Credits Daily",
           "sourceTableName": "report_invoice_credits_daily",
           "refreshProcedureName": "refresh_report_invoice_credits_daily",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
 ## Sample Data
 
 | Tenant Record Id | Currency | Day        | Count    |
 |------------------|----------|------------|----------|
-| 1                | USD      | 2025-05-05 | 0.0000   |
 | 1                | USD      | 2025-09-19 | 80.0000  |
 | 22               | USD      | 2025-09-19 | 125.0000 |
 | 22               | EUR      | 2025-09-22 | 45.0000  |
 | 22               | USD      | 2025-09-18 | -10.0000 |
 
-This means that on `2025-09-19`, there was a total invoice credit of `$80` for the tenant_record_id=1.
+The first row in the above table indicates that on `2025-09-19`, there was a total invoice credit of `$80` for the tenant_record_id=1.
 
 
 ## Report UI:
diff --git a/reports/invoice_credits_monthly/README.md b/reports/invoice_credits_monthly/README.md
@@ -22,7 +22,7 @@ curl -v \
           "reportPrettyName": "Invoice Credits Monthly Report",
           "sourceTableName": "report_invoice_credits_monthly",
           "refreshProcedureName": "refresh_report_invoice_credits_monthly",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
diff --git a/reports/invoice_item_adjustments_daily/README.md b/reports/invoice_item_adjustments_daily/README.md
@@ -20,7 +20,7 @@ curl -v \
           "reportPrettyName": "Invoice Item Adjustments Daily",
           "sourceTableName": "report_invoice_item_adjustments_daily",
           "refreshProcedureName": "refresh_report_invoice_item_adjustments_daily",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
@@ -38,7 +38,7 @@ curl -v \
 | 1                | USD      | 2025-09-19 | -19.3100  |
 | 489              | USD      | 2025-09-19 | -10.0000  |
 
-This means that on the date `2025-08-28`, the tenant with record id=1 had a total invoice adjustments of EUR 10.
+The first row in the above table indicates that on the date `2025-08-28`, the tenant with record id=1 had a total invoice adjustments of EUR 10.
 
 ## Report UI:
 
diff --git a/reports/invoice_item_adjustments_monthly/README.md b/reports/invoice_item_adjustments_monthly/README.md
@@ -22,7 +22,7 @@ curl -v \
           "reportPrettyName": "Invoice Item Adjustments Monthly Report",
           "sourceTableName": "report_invoice_item_adjustments_monthly",
           "refreshProcedureName": "refresh_report_invoice_item_adjustments_monthly",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
diff --git a/reports/invoice_items_monthly/README.md b/reports/invoice_items_monthly/README.md
@@ -22,7 +22,7 @@ curl -v \
           "reportPrettyName": "Invoice Items Monthly Report",
           "sourceTableName": "report_invoice_items_monthly",
           "refreshProcedureName": "refresh_report_invoice_items_monthly",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
diff --git a/reports/invoices_balance_daily/README.md b/reports/invoices_balance_daily/README.md
@@ -18,9 +18,23 @@ curl -v \
           "reportPrettyName": "Daily Invoices Balance",
           "sourceTableName": "report_invoices_balance_daily",
           "refreshProcedureName": "refresh_report_invoices_balance_daily",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
+
+## Sample Data
+
+| tenant_record_id | currency | day        | count   |
+|------------------|----------|------------|---------|
+| 1                | EUR      | 2025-09-15 | 15.0000 |
+| 1                | EUR      | 2025-09-01 | 0.0000  |
+| 1                | USD      | 2025-09-15 | 42.9000 |
+| 2                | USD      | 2025-09-02 | 59.5000 |
+| 2                | EUR      | 2025-09-16 | 0.0000  |
+
+
+The first row in the above table indicates that on the date `2025-09-15`, the tenant with record id=1 had a total invoice balance of EUR 15.
+
 ## Report UI:
 
 ![invoice-balance-daily.png](invoice-balance-daily.png)
diff --git a/reports/invoices_balance_daily/invoice-balance-daily.png b/reports/invoices_balance_daily/invoice-balance-daily.png
diff --git a/reports/invoices_balance_daily/v_report_invoices_balance_daily.ddl b/reports/invoices_balance_daily/v_report_invoices_balance_daily.ddl
@@ -1,11 +1,12 @@
 create or replace view v_report_invoices_balance_daily as
 select
   ai.tenant_record_id
+, ai.currency
 , date_format(ai.created_date,'%Y-%m-%d') as day
 , sum(ai.converted_balance) as count
 from
   analytics_invoices ai
 where 1=1
   and ai.report_group='default'
-group by 1,2
+group by 1,2,3
 ;
diff --git a/reports/invoices_daily/README.md b/reports/invoices_daily/README.md
@@ -18,10 +18,27 @@ curl -v \
           "reportPrettyName": "Daily Invoices Value",
           "sourceTableName": "report_invoices_daily",
           "refreshProcedureName": "refresh_report_invoices_daily",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
+## Sample Data
+
+| ID  | Date       | Currency | Amount    |
+|-----|------------|----------|-----------|
+| 1   | 2025-09-05 | USD      | 579.0700  |
+| 1   | 2025-09-19 | USD      | 728.4000  |
+| 1   | 2025-09-22 | USD      | 100.0000  |
+| 489 | 2025-09-21 | USD      | 250.0000  |
+| 1   | 2025-09-25 | EUR      | 59.9500   |
+| 359 | 2025-09-25 | USD      | 1009.3000 |
+| 1   | 2025-09-11 | USD      | 516.9500  |
+| 1   | 2025-09-28 | EUR      | 0.0000    |
+| 359 | 2025-09-28 | USD      | 356.6900  |
+
+The first row in the above table indicates that on the date `2025-09-05`, the tenant with record id=1 had a total invoice value of USD 579.0700.
+
+
 ## Report UI:
 
 ![invoice-amount-daily.png](invoice-amount-daily.png)
diff --git a/reports/invoices_daily/invoice-amount-daily.png b/reports/invoices_daily/invoice-amount-daily.png
diff --git a/reports/invoices_monthly/README.md b/reports/invoices_monthly/README.md
@@ -22,7 +22,7 @@ curl -v \
           "reportPrettyName": "Invoices Monthly Report",
           "sourceTableName": "report_invoices_monthly",
           "refreshProcedureName": "refresh_report_invoices_monthly",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
diff --git a/reports/mrr/README.md b/reports/mrr/README.md
@@ -18,7 +18,7 @@ curl -v \
           "reportPrettyName": "Daily MRR",
           "sourceTableName": "report_mrr_daily",
           "refreshProcedureName": "refresh_report_mrr_daily",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
@@ -33,6 +33,9 @@ curl -v \
 | 24               | ALL     | 2025-01-06 | 150.00 |
 
 
+TODO: - add currency to view??
+// The first row in the above table indicates that on the date `2025-01-05`, the MRR for the `Pistol` product was $150 for `tenant_record_id=1`.
+
 ## Report UI:
 
 ![daily-mrr.png](daily-mrr.png)
diff --git a/reports/new_accounts_daily/README.md b/reports/new_accounts_daily/README.md
@@ -22,6 +22,21 @@ curl -v \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
+## Sample Data
+
+| ID | Date       | Value |
+|----|------------|-------|
+| 1  | 2025-09-18 | 4     |
+| 1  | 2025-09-19 | 4     |
+| 2  | 2025-09-19 | 4     |
+| 1  | 2025-09-21 | 1     |
+| 2  | 2025-09-21 | 1     |
+| 1  | 2025-09-22 | 1     |
+
+
+The first row in the above table indicates that on the date `2025-09-18`, the tenant with record id=1 had 4 new accounts created.
+
+
 ## Report UI:
 
 ![daily-new-accounts.png](daily-new-accounts.png)
diff --git a/reports/overdue-states-count-daily/README.md b/reports/overdue-states-count-daily/README.md
@@ -34,7 +34,8 @@ curl -v \
 | 23               | BLOCKED      | 2025-09-19 | 7     |
 | 45               | CANCELLATION | 2025-09-19 | 5     |
 
-This means that on `2025-09-15`, 5 accounts were in `BLOCKED` overdue state for the tenant_record_id=1.
+
+The first row in the above table indicates that on the date `2025-09-15`, the tenant with record id=1 had 5 accounts in the `BLOCKED` overdue state.
 
 ## Report UI:
 
diff --git a/reports/payments_monthly/README.md b/reports/payments_monthly/README.md
@@ -22,7 +22,7 @@ curl -v \
           "reportPrettyName": "Payments Monthly Report",
           "sourceTableName": "report_payments_monthly",
           "refreshProcedureName": "refresh_report_payments_monthly",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
diff --git a/reports/payments_total_daily/README.md b/reports/payments_total_daily/README.md
@@ -1,6 +1,6 @@
 # Daily Payments Report
 
-Compute the total value (in the reference currency) of captured payments per day per currency.
+Compute the total value (in the reference currency) of payments per day per currency.
 
 The snapshot view is: `v_report_payments_total_daily`
 
@@ -22,6 +22,18 @@ curl -v \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
+## Sample Data
+
+| tenant_record_id | day        | currency | amount   |
+|------------------|------------|----------|----------|
+| 1                | 2025-05-01 | USD      | 49.9000  |
+| 1                | 2025-05-05 | USD      | 26.0900  |
+| 1                | 2025-05-05 | EUR      | 79.8500  |
+| 2                | 2025-07-03 | USD      | 229.6000 |
+| 2                | 2025-07-20 | EUR      | 379.9000 |
+
+The first row in the above table indicates that on the date `2025-05-01`, the tenant with record id=1 had a total payment value of USD 49.9.
+
 ## Report UI:
 
 ![payments-total-daily.png](payments-total-daily.png)
diff --git a/reports/refunds-monthly/README.md b/reports/refunds-monthly/README.md
@@ -22,7 +22,7 @@ curl -v \
           "reportPrettyName": "Refunds Monthly Report",
           "sourceTableName": "report_refunds_monthly",
           "refreshProcedureName": "refresh_report_refunds_monthly",
-          "refreshFrequency": "DAILY"}' \
+          "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
diff --git a/reports/refunds_total_daily/README.md b/reports/refunds_total_daily/README.md
@@ -22,6 +22,18 @@ curl -v \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
+## Sample Data
+
+| ID | Date       | Currency | Amount   |
+|----|------------|----------|----------|
+| 1  | 2025-09-02 | USD      | 119.0000 |
+| 1  | 2025-08-04 | USD      | 29.9500  |
+| 1  | 2025-08-04| EUR      | 199.4000 |
+| 2  | 2025-07-03 | USD      | 29.9500  |
+| 2  | 2025-09-18 | EUR      | 15.0000  |
+
+The first row in the above table indicates that on the date `2025-09-02`, the tenant with record id=1 had a total refund value of USD 119.
+
 ## Report UI:
 
 ![refunds-total-daily.png](refunds-total-daily.png)
diff --git a/reports/subscribers-vs-non-subscribers/README.md b/reports/subscribers-vs-non-subscribers/README.md
@@ -22,6 +22,19 @@ curl -v \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
 
+## Sample Data
+
+| ID  | Type           | Count |
+|-----|----------------|-------|
+| 1   | Non-subscriber | 74    |
+| 1   | Subscriber     | 18    |
+| 2   | Subscriber     | 1     |
+| 5   | Non-subscriber | 1     |
+| 5   | Subscriber     | 3     |
+
+The first row in the above table indicates that the tenant with record id=1 had 74 non-subscribers (accounts with no active subscriptions).
+
+
 ## Report UI:
 
 ![subscribers-vs-non-subscribers.png](subscribers-vs-non-subscribers.png)
diff --git a/reports/trial-starts-count-daily/README.md b/reports/trial-starts-count-daily/README.md
diff --git a/reports/trial-to-no-trial-conversions_daily/README.md b/reports/trial-to-no-trial-conversions_daily/README.md
