Differences

This shows you the differences between two versions of the page.

--- applications:report-fetcher [2025/03/30 16:20] – removed - external edit (Unknown date) 127.0.0.1
+++ applications:report-fetcher [2026/03/20 09:38] (current) – add persist parameter details root
@@ Line 1: / Line 1: @@
+====== Guild Report Fetcher ======
+The Guild report fetcher is a service to extract sales reports from the Guild admin panel. It is reachable at ''reports.cssbham.com''.
+It is run in a Docker container on [[infrastructure:servers:tex-drug-den|tex-drug-den]].
+Source code repository: [[https://github.com/CSSUoB/Guild-Customisation-Report-Fetcher|Guild-Customisation-Report-Fetcher]]
+===== Usage =====
+Send the following as query parameters to ''https://reports.cssbham.com/customisation_report''.
+^ Key ^ Example Value ^
+| organisation_id | 6531 |
+| product_name | CSS Ball 2024 |
+| auth_cookie |  |
+| report_type | Purchasers |
+| start_date | 2025-12-25 |
+| end_date | 2026-01-25 |
+| persist | True |
+For example:
+<code>
+curl 'https://reports.cssbham.com/customisation_report?organisation_id=6531&product_name=CSS%20Ball%202024&auth_cookie=[redacted]'
+</code>
+The `report_type` parameter is not required, and will default to the Customisations Report if not specified.
+The `start_date` and `end_date` parameters are also not required, and the time period will default to all time if not specified.
+The `product_name` parameter should contain just one name, if you wish to return data for multiple events, this should be passed as a list of CSVs to `product_names`. Only one of these should be used at a time. If you try to pass both `product_name` and `product_names` in the same query it will return an error.
+The `persist` parameter is a new key implemented due to a change in the MSL authentication handling which means that auth cookies now expire in ~15 minutes. It's obviously not feasible to refresh the cookie every 15 minutes, so instead if `persist` is set to True, the system will store the auth token given, and every 10 minutes or so, refresh it. This new refreshed cookie is only stored in living memory, so if the application shuts down then the refreshed cookie will be lost and a new one will need to be provided.