# UsageDailySnapshot

## Example UsageDailySnapshot Object

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

* `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.
* `user_count` (int64): Number of billable users as of this day.
* `current_storage` (double): GB of Files Native Storage used on this day.
* `deleted_files_storage` (double): 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` (double): 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` (double): 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

---

## List Usage Daily Snapshots

```
await UsageDailySnapshot.list
```


### Parameters

* `cursor` (string): 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_page` (int64): Number of records to show per page.  (Max: 10,000, 1,000 or less is recommended).
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `date`.
* `filter` (object): 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 ]`.
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `date`.
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `date`.
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `date`.
* `filter_lteq` (object): If set, return records where the specified field is less than or equal the supplied value. Valid fields are `date`.