Merge pull request #175 from killbill/reports-cleanup

Reports cleanup

Author: reshmabidikar

.idea/misc.xml

@@ -1,10 +1,10 @@
-# Accounts summary report
+# Accounts Summary Report
 
 Provides an account summary. Provides details like account balance, account status, currency, etc.
 
 The snapshot view is: `v_report_accounts_summary`
 
-## Pie chart configuration
+## Report Creation
 
 ```
 curl -v \
@@ -15,9 +15,15 @@ curl -v \
      -H 'Content-Type: application/json' \
      -d '{"reportName": "report_accounts_summary",
           "reportType": "TABLE",
-          "reportPrettyName": "Accounts summary",
+          "reportPrettyName": "Accounts Summary",
           "sourceTableName": "report_accounts_summary",
           "refreshProcedureName": "refresh_report_accounts_summary",
           "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
+
+## Report UI:
+
+![accounts-summary.png](accounts-summary.png)
+
+

reports/README.md

@@ -0,0 +1,40 @@
+# Monthly Active Subscriptions Report
+
+Compute (at the end of each month) the total number of active subscriptions per product and billing period.
+
+The snapshot view is: `v_report_active_by_product_term_monthly`
+
+## Report Creation
+
+```
+curl -v \
+     -X POST \
+     -u admin:password \
+     -H "X-Killbill-ApiKey:bob" \
+     -H "X-Killbill-ApiSecret:lazar" \
+     -H 'Content-Type: application/json' \
+     -d '{"reportName": "report_active_by_product_term_monthly",
+          "reportType": "TIMELINE",
+          "reportPrettyName": "Monthly Active Subscriptions by Product Term",
+          "sourceTableName": "report_active_by_product_term_monthly",
+          "refreshProcedureName": "refresh_active_by_product_term_monthly",
+          "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)

reports/accounts_summary/README.md

@@ -11,27 +11,7 @@ DECLARE EXIT HANDLER FOR SQLWARNING ROLLBACK;
 SET TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;
 START TRANSACTION;
   delete from report_active_by_product_term_monthly;
-  insert into report_active_by_product_term_monthly
-  select
-    x.tenant_record_id
-  , cal.d day
-  , x.product_name
-  , x.billing_period
-  , x.count
-  from calendar cal
-  join (
-    select
-      tenant_record_id
-    , last_day(day) day
-    , product_name
-    , billing_period
-    , count
-    from
-      v_report_active_by_product_term_monthly
-    where 1=1
-  ) x on last_day(cal.d) = x.day
-  where 1=1
-  ;
+  insert into report_active_by_product_term_monthly select * from v_report_active_by_product_term_monthly;
 COMMIT;
 
 END;

reports/accounts_summary/accounts-summary.png

@@ -4,7 +4,7 @@ Provides a subscription bundle summary. Provides details like CTD, plan name, pr
 
 The snapshot view is: `v_report_bundles_summary`
 
-## Pie chart configuration
+## Report Creation
 
 ```
 curl -v \
@@ -15,9 +15,13 @@ curl -v \
      -H 'Content-Type: application/json' \
      -d '{"reportName": "report_bundles_summary",
           "reportType": "TABLE",
-          "reportPrettyName": "Bundles summary",
+          "reportPrettyName": "Bundles Summary",
           "sourceTableName": "report_bundles_summary",
           "refreshProcedureName": "refresh_report_bundles_summary",
           "refreshFrequency": "HOURLY"}' \
      "http://127.0.0.1:8080/plugins/killbill-analytics/reports"
 ```
+
+## Report UI:
+
+![bundles-summary.png](bundles-summary.png)