Event Webservice

Get a count of saved clips in an organization

Get a count of saved clips in and organization

post/api/event/getSavedClipCount

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/event/getSavedClipCount
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

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.

Request body

deviceFilterstring[] nullable

List of device UUIDs to filter clips by

endTimeMsinteger nullable

End time in milliseconds for filtering clips

locationFilterstring[] nullable

List of location UUIDs to filter clips by

startTimeMsinteger nullable

Start time in milliseconds for filtering clips

Example request

{
  "deviceFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "endTimeMs": 1641081600000,
  "locationFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "startTimeMs": 1640995200000
}

Response

OK

countinteger nullable

Count of org-wide saved clips matching the filter criteria

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
privateCountinteger nullable

Count of private saved clips matching the filter criteria

warningMsgstring nullable

Example response

{
  "count": 42,
  "privateCount": 10
}

Changes

No recorded changes to this operation across all 1 revision of this API.