Skip to main content
POST
/
api
/
event
/
getClipsWithProgress
Get list of saved clips in organization, with current progress
curl --request POST \
  --url https://api2.rhombussystems.com/api/event/getClipsWithProgress \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "pageSize": 100,
  "deviceUuidFilters": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "excludeAlertMonitoringClips": false,
  "filterByPrivate": false,
  "locationUuidFilters": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "pageToken": "next_page_token_123",
  "searchFilter": "motion detected",
  "sortField": "timestamp",
  "sortOrder": "desc",
  "timestampFilterField": "<string>",
  "timestampMsAfter": 1640995200000,
  "timestampMsBefore": 1641081600000
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "pageToken": "<string>",
  "savedClips": [
    {
      "accessSettings": {
        "allowedRoles": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "allowedUsers": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "visibility": "PRIVATE"
      },
      "alterMap": {},
      "analyzed": true,
      "byteCount": 123,
      "clipLocation": {
        "region": "<string>"
      },
      "consoleDelete": true,
      "createdAtMs": 123,
      "currentOperation": "Processing video",
      "description": "<string>",
      "devicePresentationOrder": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "deviceUuidMap": {},
      "deviceUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "durationSec": 123,
      "externalTransactionId": "<string>",
      "fisheyeMap": {},
      "integrationUploadList": [
        "AVIGILON_ALTA"
      ],
      "isMonitoringClip": true,
      "isVendorClip": true,
      "lastUpdatedSec": 1640995200,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "percentComplete": 75,
      "sendToSharedStorage": true,
      "sha256Hex": "<string>",
      "sourceAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "status": "INITIATING",
      "thumbnailLocation": {
        "region": "<string>"
      },
      "timestampMs": 123,
      "title": "<string>",
      "userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "videoResolution": {
        "height": 123,
        "width": 123
      }
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for retrieving clips with progress information and filtering options.

pageSize
integer<int32> | null
default:100
required

Page size

Required range: 1 <= x <= 200
deviceUuidFilters
(string<RUUID> | null)[] | null

Device uuids to filter clips by.

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

excludeAlertMonitoringClips
boolean | null
default:false

Filter to exclude clips created for alarm monitoring verification.

filterByPrivate
boolean | null
default:false

Filter to only include private clips in the result.

locationUuidFilters
(string<RUUID> | null)[] | null

Location uuids to filter clips by.

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

pageToken
string | null

Page token received from the previous search request.

Example:

"next_page_token_123"

searchFilter
string | null

Search filter for clips

Example:

"motion detected"

sortField
string | null

Field to sort clips by

Example:

"timestamp"

sortOrder
string | null

Sort order (asc or desc)

Example:

"desc"

timestampFilterField
string | null

Timestamp to filter clips by (either clip creation date or clip footage date).

timestampMsAfter
integer<int64> | null

Timestamp to find clips after this time.

Example:

1640995200000

timestampMsBefore
integer<int64> | null

Timestamp to find clips before this time

Example:

1641081600000

Response

200 - application/json

OK

Response object containing clips with progress information.

error
boolean | null
errorMsg
string | null
pageToken
string | null

Token to be supplied on the next search request to get the next page. If token is null, there is no more data available.

savedClips
object[] | null

List of saved clips with progress information

warningMsg
string | null