files

List a session's captured files

Changed on

Returns the files this session captured off its phone, newest first — the direct answer to "what did this session capture". Every row is source=capture. Rows appear at detection, before the bytes finish moving, so a caller waiting on a file watches its capture state progress rather than an empty list.

get/phones/sessions/{session_id}/files

Request

Path parameters

session_idstring uuid required

session whose captures to list

Query parameters

limitinteger

max items per page

offsetinteger

pagination offset

searchstring

filter by filename, case-insensitive substring match

mime_typestring

only files of exactly this media type

min_size_bytesinteger

only files at least this many bytes (0 = no bound)

max_size_bytesinteger

only files at most this many bytes (0 = no bound)

created_afterstring date-time

only files registered at or after this time (RFC 3339)

created_beforestring date-time

only files registered at or before this time (RFC 3339)

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

totalinteger required

Total files matching the query.

Example response

{
  "$schema": "/api/v1/FileListResponse.json",
  "files": [
    {
      "$schema": "/api/v1/FileSummary.json"
    }
  ]
}

Changes

    • warning

      deleted the query request parameter q

    • warning

      added the new message enum value to the // response property for the response status

    • info

      added the new optional query request parameter search

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      endpoint added