v4

latestSwagger 2.02026-08-0343714211.7 MB

usage_daily_snapshots

Usage Daily Snapshots

List Usage Daily Snapshots

get/usage_daily_snapshots

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are date.

If set, return records where the specified field is equal to the supplied value. Valid fields are date and usage_snapshot_id. Valid field combinations are [ usage_snapshot_id, date ].

If set, return records where the specified field is greater than the supplied value. Valid fields are date.

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are date.

If set, return records where the specified field is less than the supplied value. Valid fields are date.

If set, return records where the specified field is less than or equal the supplied value. Valid fields are date.

Response

A list of UsageDailySnapshots objects.

idinteger

ID of the usage record

datestring date

The date of this usage record

api_usage_availableboolean

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_usageinteger

Read API Calls used on this day. Note: only updated for days before the current day.

write_api_usageinteger

Write API Calls used on this day. Note: only updated for days before the current day.

transformation_credits_usageinteger

Transformation and AI credits used on this day. Note: initially this tracks GPG encrypt, decrypt, and recrypt usage.

user_countinteger

Number of billable users as of this day.

current_storageinteger

GB of Files Native Storage used on this day.

deleted_files_storageinteger

GB of Files Native Storage used on this day for files that have been deleted and are stored as backups.

deleted_files_counted_in_minimuminteger

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_storageinteger

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

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
      }
    ]
  }
]