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
}
'{
"error": true,
"errorMsg": "<string>",
"pageToken": "<string>",
"savedClips": [
{
"accessSettings": {
"allowedRoles": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"allowedUsers": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"visibility": "PRIVATE"
},
"alterMap": {},
"analyzed": true,
"byteCount": 123,
"clipLocation": {
"region": "<string>"
},
"clipLocationV2": "<string>",
"consoleDelete": true,
"createdAtMs": 123,
"currentOperation": "Processing video",
"description": "<string>",
"deviceIntervalMap": {},
"devicePresentationOrder": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
"deviceUuidMap": {},
"deviceUuids": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"durationSec": 123,
"externalTransactionId": "<string>",
"fisheyeHardware": "RASPBERRY_PI_3",
"fisheyeMap": {},
"integrationUploadList": [
"AVIGILON_ALTA"
],
"isMonitoringClip": true,
"isVendorClip": true,
"lastUpdatedSec": 1640995200,
"mountingDirection": "DOWN",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"percentComplete": 75,
"sendToSharedStorage": true,
"sha256Hex": "<string>",
"sourceAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"status": "INITIATING",
"thumbnailLocation": {
"region": "<string>"
},
"thumbnailLocationV2": "<string>",
"timestampMs": 123,
"title": "<string>",
"userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA",
"videoResolution": {
"height": 123,
"width": 123
}
}
],
"warningMsg": "<string>"
}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
}
'{
"error": true,
"errorMsg": "<string>",
"pageToken": "<string>",
"savedClips": [
{
"accessSettings": {
"allowedRoles": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"allowedUsers": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"visibility": "PRIVATE"
},
"alterMap": {},
"analyzed": true,
"byteCount": 123,
"clipLocation": {
"region": "<string>"
},
"clipLocationV2": "<string>",
"consoleDelete": true,
"createdAtMs": 123,
"currentOperation": "Processing video",
"description": "<string>",
"deviceIntervalMap": {},
"devicePresentationOrder": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
"deviceUuidMap": {},
"deviceUuids": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"durationSec": 123,
"externalTransactionId": "<string>",
"fisheyeHardware": "RASPBERRY_PI_3",
"fisheyeMap": {},
"integrationUploadList": [
"AVIGILON_ALTA"
],
"isMonitoringClip": true,
"isVendorClip": true,
"lastUpdatedSec": 1640995200,
"mountingDirection": "DOWN",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"percentComplete": 75,
"sendToSharedStorage": true,
"sha256Hex": "<string>",
"sourceAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"status": "INITIATING",
"thumbnailLocation": {
"region": "<string>"
},
"thumbnailLocationV2": "<string>",
"timestampMs": 123,
"title": "<string>",
"userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA",
"videoResolution": {
"height": 123,
"width": 123
}
}
],
"warningMsg": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt
Use this file to discover all available pages before exploring further.
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.
api-token, api, partner-api-token, partner-api Request object for retrieving clips with progress information and filtering options.
Page size
1 <= x <= 200Device uuids to filter clips by.
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
Filter to exclude clips created for alarm monitoring verification.
Filter to only include private clips in the result.
Location uuids to filter clips by.
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
Page token received from the previous search request.
"next_page_token_123"
Search filter for clips
"motion detected"
Field to sort clips by
"timestamp"
Sort order (asc or desc)
"desc"
Timestamp to filter clips by (either clip creation date or clip footage date).
Timestamp to find clips after this time.
1640995200000
Timestamp to find clips before this time
1641081600000
OK
Response object containing clips with progress information.
Token to be supplied on the next search request to get the next page. If token is null, there is no more data available.
List of saved clips with progress information
Show child attributes
Was this page helpful?