FIfiles
site
Usage Snapshots

Get the most recent usage snapshot (usage data for billing purposes) for a Site.

Changed on

Get the most recent usage snapshot (usage data for billing purposes) for a Site.

get/site/usage

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/site/usage
  • Auth
    none declared

Response

The Site object.

idinteger

Usage snapshot ID

start_atstring date-time

Usage snapshot start date/time

end_atstring date-time

Usage snapshot end date/time

high_water_user_countinteger

Highest user count number in time period

transformation_credits_usageinteger

Total Transformation and AI credits used in this usage period. Updated daily. Does not include credits consumed today.

current_storageinteger

Current total Storage Usage GB as of end date (not necessarily high water mark, which is used for billing)

high_water_storageinteger

Highest Storage Usage GB recorded in time period (used for billing)

root_storageinteger

Storage Usage for root folder as of end date (not necessarily high water mark, which is used for billing)

deleted_files_counted_in_minimuminteger

Storage Usage for files that are deleted but uploaded within last 30 days as of end date (not necessarily high water mark, which is used for billing)

deleted_files_storageinteger

Storage Usage for files that are deleted but retained as backups as of end date (not necessarily high water mark, which is used for billing)

total_billable_usageinteger

Storage + Transfer Usage - Total Billable amount

total_billable_transfer_usageinteger

Transfer usage for period - Total Billable amount

bytes_sentinteger

Transfer Usage for period - Outbound GB from Files Native Storage

sync_bytes_receivedinteger

Transfer Usage for period - Inbound GB to Remote Servers (Sync/Mount)

sync_bytes_sentinteger

Transfer Usage for period - Outbound GB from Remote Servers (Sync/Mount)

Example response

{
  "id": 1,
  "start_at": "2000-01-01T01:00:00Z",
  "end_at": "2000-01-01T01:00:00Z",
  "high_water_user_count": 1,
  "transformation_credits_usage": 1,
  "current_storage": 1,
  "high_water_storage": 1,
  "root_storage": 1,
  "deleted_files_counted_in_minimum": 1,
  "deleted_files_storage": 1,
  "total_billable_usage": 1,
  "total_billable_transfer_usage": 1,
  "bytes_sent": 1,
  "sync_bytes_received": 1,
  "sync_bytes_sent": 1,
  "usage_by_top_level_dir": [
    {
      "dir": "dir",
      "size": 100,
      "count": 10
    }
  ]
}

Changes

  • 3bb8c8a06041Revision changes
    • warning

      deleted the query request parameter format

    • warning

      deleted the query request parameter site

    • info

      api tag Usage Snapshots added

  • 334e0cf90234Revision changes
    • info

      api operation id getSiteUsage removed and replaced with GetSiteUsage

    • info

      added the new optional query request parameter format

    • info

      added the new optional query request parameter site