Skip to main content
POST
/
api
/
event
/
getSharedClipGroupDetails
Get detailed information about a shared clip page, including seekpoints and bounding boxes
curl --request POST \
  --url https://api2.rhombussystems.com/api/event/getSharedClipGroupDetails \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "sharedClipGroup": {
    "createdAtMillis": 123,
    "description": "<string>",
    "expirationTimeSecs": 123,
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "sharedClips": [
      {
        "boundingBoxes": [
          {
            "activity": "SOUND_LOUD",
            "alert": true,
            "bottom": 123,
            "confidence": 123,
            "croppedImageLocator": "<string>",
            "customActivityColor": "BLUE",
            "customActivityDescription": "<string>",
            "customActivityDisplayName": "<string>",
            "faceName": "<string>",
            "inMotion": true,
            "keypointsV2": {},
            "left": 123,
            "licensePlate": "<string>",
            "loudness": 123,
            "objectId": 123,
            "pose": "<string>",
            "relativeSecond": 123,
            "right": 123,
            "sensorValType": {
              "sensorBoolean": true,
              "sensorDouble": 123,
              "sensorLong": 123
            },
            "toastOrderIdInfo": {
              "employeeName": "<string>",
              "guid": "<string>",
              "locationName": "<string>",
              "restaurantName": "<string>",
              "toastCheckInfo": {
                "totalAmount": 123
              }
            },
            "top": 123,
            "unidentifiedFaceId": "<string>",
            "vehicleName": "<string>"
          }
        ],
        "clipLocation": {
          "region": "<string>"
        },
        "description": "<string>",
        "deviceUuidMap": {},
        "durationSec": 123,
        "seekPoints": [
          {
            "activity": "SOUND_LOUD",
            "alert": true,
            "customActivityColor": "BLUE",
            "customActivityDescription": "<string>",
            "customActivityDisplayName": "<string>",
            "dcao": true,
            "faceName": "<string>",
            "id": 123,
            "inMotion": true,
            "licensePlate": "<string>",
            "loudness": 123,
            "pose": "<string>",
            "relativeSecond": 123,
            "sensorValType": {
              "sensorBoolean": true,
              "sensorDouble": 123,
              "sensorLong": 123
            },
            "toastOrderIdInfo": {
              "employeeName": "<string>",
              "guid": "<string>",
              "locationName": "<string>",
              "restaurantName": "<string>",
              "toastCheckInfo": {
                "totalAmount": 123
              }
            },
            "tu": "<string>",
            "unidentifiedFaceId": "<string>",
            "vehicleName": "<string>"
          }
        ],
        "startTime": 123,
        "thumbnailLocation": {
          "region": "<string>"
        },
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "title": "<string>",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  },
  "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 detailed information about a shared clip group.

uuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object containing detailed information about a shared clip group.

error
boolean | null
errorMsg
string | null
sharedClipGroup
object

Detailed information about the shared clip group

warningMsg
string | null