Skip to content

Usage Reporting

The Flywheel SDK provides endpoints for querying storage and compute usage across the site. These endpoints require admin permissions.

Overview

Flywheel offers two categories of usage reports:

  • Storage reports — show how much data is stored at the site and project level
  • Usage reports — show job activity and compute consumption over time

Site-wide storage report

fw.get_site_report() returns a summary of storage consumption across all groups and projects on the site:

Get the site-wide storage report (admin only)
--8 < --"test_docs_admin_concepts.py:get_site_report"

Project-level storage report

fw.get_project_report() returns a breakdown of storage usage by one or more projects. Optionally, start_date and end_date can be provided to filter by date:

Get storage report for specific projects with date filter
from datetime import datetime

--8 < --"test_docs_admin_concepts.py:get_project_report"

Usage report by month

fw.get_usage_report() returns job-level usage statistics for a given month. If no month is specified, the current month is used:

Get usage report for the current month
--8 < --"test_docs_admin_concepts.py:get_usage_report"
Get usage report for a specific month
--8 < --"test_docs_admin_concepts.py:get_usage_report_month"
Get usage report filtered to a specific project
--8 < --"test_docs_admin_concepts.py:get_usage_report_project"

Daily usage reports

For finer-grained breakdowns, use the daily usage endpoint:

Get daily usage for a specific month
--8 < --"test_docs_admin_concepts.py:get_daily_usage_report"

Aggregating storage across projects

A common pattern for capacity planning is to iterate through projects and aggregate their storage into a summary:

Aggregate storage usage across one or more projects
--8 < --"test_docs_admin_concepts.py:aggregate_storage"

Checking usage data availability

Before querying historical usage, check which date ranges have data available:

Check usage data availability
--8 < --"test_docs_admin_concepts.py:get_usage_availability"