Usage Daily Snapshots

A UsageDailySnapshot is a detailed site-wide usage report for the day. Includes information about users, API, and storage.

List Usage Daily Snapshots

Endpoint

GET/usage_daily_snapshots

Return Object

UsageDailySnapshot[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

curl https://app.files.com/api/rest/v1/usage_daily_snapshots.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "id": 1,
    "date": "2000-01-01T01:00:00Z",
    "api_usage_available": true,
    "read_api_usage": 1,
    "write_api_usage": 1,
    "transformation_credits_usage": 1,
    "user_count": 1,
    "current_storage": 1,
    "deleted_files_storage": 1,
    "deleted_files_counted_in_minimum": 1,
    "root_storage": 1,
    "usage_by_top_level_dir": [
      {
        "dir": "dir",
        "size": 100,
        "count": 10
      }
    ]
  }
]

The UsageDailySnapshot Object

Some of the endpoints above return a UsageDailySnapshot object. The attributes of this object are listed below.

Attribute	Description
id int64	ID of the usage record
date date	The date of this usage record
api_usage_available boolean	True if the API usage fields `read_api_usage` and `write_api_usage` can be relied upon. If this is false, we suggest hiding that value from any UI.
read_api_usage int64	Read API Calls used on this day. Note: only updated for days before the current day.
write_api_usage int64	Write API Calls used on this day. Note: only updated for days before the current day.
transformation_credits_usage int64	Transformation and AI credits used on this day. Note: only updated for days before the current day.
user_count int64	Number of billable users as of this day.
current_storage int64	GB of Files Native Storage used on this day.
deleted_files_storage int64	GB of Files Native Storage used on this day for files that have been deleted and are stored as backups.
deleted_files_counted_in_minimum int64	GB of Files Native Storage used on this day for files that have been permanently deleted but were uploaded less than 30 days ago, and are still billable.
root_storage int64	GB of Files Native Storage used for the root folder. Included here because this value will not be part of `usage_by_top_level_dir`
usage_by_top_level_dir array(object)	Usage broken down by each top-level folder

Example UsageDailySnapshot Object

{
  "id": 1,
  "date": "2000-01-01T01:00:00Z",
  "api_usage_available": true,
  "read_api_usage": 1,
  "write_api_usage": 1,
  "transformation_credits_usage": 1,
  "user_count": 1,
  "current_storage": 1,
  "deleted_files_storage": 1,
  "deleted_files_counted_in_minimum": 1,
  "root_storage": 1,
  "usage_by_top_level_dir": [
    {
      "dir": "dir",
      "size": 100,
      "count": 10
    }
  ]
}