LiquidFiles Documentation
LiquidFiles Documentation

View Shares Log API

Using the API call, you can view the Share Log.

Request Info
Info Value
Request URL /shares/_share_id_/logs
Request VERB GET
Request Parameters
Parameter Type Description
after Date/ID View Logs after this date/id, you can specify after using one of the following formats:
  • YYYY-MM-DD hh:mm:ss — after this date and time (in system time zone).
    Ex: 2024-02-15 14:01:02
  • YYYY-MM-DD — after this date (in system time zone).
    Ex: 2024-02-15
  • YYYYMMDD — after this date (in system time zone).
    Ex: 20240215
  • Log ID — after this log ID.
    Ex: 20240219153857657520
in_the_last Integer In the last number of hours — if you send 3 the log will return logs from the last 3 hours.
limit Integer Limit the number of responses. Default 100.

If you send either after or in_the_last, the response will be in ascending order. If you don't send after or in_the_last the response will be descending.

Response Parameters
Parameter Type Description
id String The Unique ID for the log entry.
action String The action that was taken. Can be 'created', 'uploaded', 'downloaded', 'updated', 'restored', 'destroyed', 'trashed' or 'moved'.
item String The path to the Share, Folder or File that was actioned.
item2 String The supplemental path to the Share, Folder or File that was actioned, if you move a file this is where the file was moved to.
user_id String The User ID that took the action.
share_id String The Share ID for the action
folder_id String The Folder ID for the action (if relevant).
file_id String The File ID for the action (if relevant).
created_at DateTime When the log was created.

Example Request in JSON

curl -X GET --user nkpIxMK9ucUUE7FvfNpdAf:x -H "Accept: application/json" \
     https://test.host/shares/project-alpha/logs?after=2024-02-19

Example Response in JSON

{"logs":
  [
    {
      "id":"20240219035239187603",
      "action":"created",
      "log_type":"folder",
      "item":"/Project Data",
      "item2":null,
      "user_id":"user-company-com",
      "share_id":"project-alpha",
      "folder_id":"project-data",
      "file_id":null,
      "created_at":"2024-02-19T03:52:39.187Z"
    },
    {
      "id":"20240219153857657520",
      "action":"uploaded",
      "log_type":"file",
      "item":"/Project Data/Project Info.doc",
      "item2":null,
      "user_id":"user-company-com",
      "share_id":"project-alpha",
      "folder_id":"project-data",
      "file_id":"project-info-doc",
      "created_at":"2024-02-19T04:38:57.657Z"
    }
  ]
}