List History
List_HistoryRead-only
Retrieve a site's full action history with options to filter by date, user, or path, sort by timestamp, and paginate results.
Instructions
List site full action history.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| start_at | No | Leave blank or set to a date/time to filter earlier entries. | |
| end_at | No | Leave blank or set to a date/time to filter later entries. | |
| display | No | Display format. Leave blank or set to `full` or `parent`. | |
| cursor | No | 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 | No | Number of records to show per page. (Max: 10000, 1,000 or less is recommended). | |
| sort_by | No | If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`. | |
| filter | No | If set, return records where the specified field is equal to the supplied value. Valid fields are `user_id`, `folder` or `path`. | |
| filter_prefix | No | If set, return records where the specified field is prefixed by the supplied value. Valid fields are `path`. | |
| fields | No | Optional list of attribute names to include as columns in the response table. When omitted, a sensible default set is used. Useful for narrowing wide entities or surfacing fields not in the default. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |