Skip to main content
POST
/
api
/
event
/
getSavedClipCount
Get a count of saved clips in an organization
curl --request POST \
  --url https://api2.rhombussystems.com/api/event/getSavedClipCount \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "deviceFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "endTimeMs": 1641081600000,
  "locationFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "startTimeMs": 1640995200000
}
'
{
  "count": 42,
  "error": true,
  "errorMsg": "<string>",
  "privateCount": 10,
  "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 the count of saved clips with filtering options.

​
deviceFilter
(string<RUUID> | null)[] | null

List of device UUIDs to filter clips by

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
endTimeMs
integer<int64> | null

End time in milliseconds for filtering clips

Example:

1641081600000

​
locationFilter
(string<RUUID> | null)[] | null

List of location UUIDs to filter clips by

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

​
startTimeMs
integer<int64> | null

Start time in milliseconds for filtering clips

Example:

1640995200000

Response

200 - application/json

OK

Response object containing the count of saved clips.

​
count
integer<int64> | null

Count of org-wide saved clips matching the filter criteria

Example:

42

​
error
boolean | null
​
errorMsg
string | null
​
privateCount
integer<int64> | null

Count of private saved clips matching the filter criteria

Example:

10

​
warningMsg
string | null