Skip to content

Deprecation of Legacy Usage Report API

Change

The Legacy Usage Report API is deprecated as of Flywheel version 21.5.0 and is scheduled to be removed in the Flywheel 23.0.0 release (October 2026).

As of version 21.5.0, the Flywheel Web UI no longer uses the Legacy Usage Report API. The Web UI now uses a newer, more efficient API that provides additional data including group information, gear job counts, and gear compute time.

The Legacy API remains accessible via the Python SDK get_legacy_usage_report method until it is removed.

Reason for Change

  • The Legacy API does not scale to sites with millions of files and thousands of projects.
  • The Legacy API only reports data accessible at the time the report is run, meaning deleted data is excluded from results.
  • The newer APIs provide richer data, including group attribution, gear job metrics, and soft-deleted file statistics.

Prior to the 23.0.0 release, migrate any custom integrations that use the Legacy Usage Report API to one of the supported alternatives:

  • Usage Report Summary SDK API — the get_usage_data_summary method provides server-side aggregation of usage data over a date range with support for grouping, filtering by group or project, and CSV output. This is the closest replacement for the Legacy API.
  • Daily/Monthly Usage Report SDK APIs — for detailed per-day or per-month usage data per project. See the SDK documentation for the daily and monthly report methods.
  • Web UI CSV Download — for ad hoc reporting and analysis. See Usage Report for details.