Get camera or doorbell camera seekpoints

curl --request POST \
  --url https://api2.rhombussystems.com/api/eventSearch/getCameraOrDoorbellCameraSeekpoints \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "activitySet": [
    "SOUND_LOUD"
  ],
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "durationSecs": 123,
  "includeAnyMotion": true,
  "seekpointDurationIntervalSecs": 123,
  "startTimeSec": 123
}
'

{
  "combinedSeekpoints": [
    {
      "activity": "SOUND_LOUD",
      "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "customActivityColor": "BLUE",
      "customActivityDescription": "A person was detected in the camera view",
      "customActivityDisplayName": "Person Detected",
      "faceName": "John Doe",
      "licensePlate": "ABC123",
      "objectId": 12345,
      "originalEvent": {},
      "seekpointEndTimeMs": 1640995300000,
      "seekpointStartTimeMs": 1640995200000,
      "thumbnailUrl": "https://example.com/thumbnail.jpg",
      "timestampMs": 1640995200000,
      "unidentifiedFaceId": "face_12345"
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

POST

api

eventSearch

getCameraOrDoorbellCameraSeekpoints

Get camera or doorbell camera seekpoints

curl --request POST \
  --url https://api2.rhombussystems.com/api/eventSearch/getCameraOrDoorbellCameraSeekpoints \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "activitySet": [
    "SOUND_LOUD"
  ],
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "durationSecs": 123,
  "includeAnyMotion": true,
  "seekpointDurationIntervalSecs": 123,
  "startTimeSec": 123
}
'

{
  "combinedSeekpoints": [
    {
      "activity": "SOUND_LOUD",
      "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "customActivityColor": "BLUE",
      "customActivityDescription": "A person was detected in the camera view",
      "customActivityDisplayName": "Person Detected",
      "faceName": "John Doe",
      "licensePlate": "ABC123",
      "objectId": 12345,
      "originalEvent": {},
      "seekpointEndTimeMs": 1640995300000,
      "seekpointStartTimeMs": 1640995200000,
      "thumbnailUrl": "https://example.com/thumbnail.jpg",
      "timestampMs": 1640995200000,
      "unidentifiedFaceId": "face_12345"
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "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

activitySet

enum<string>[] | null

Region of allowed or disallowed activities. Activities are allowed if region group is inclusive. Activities are disallowed if region group is exclusive. Region must have at least one activity specified.

Available options:

SOUND_LOUD,

SOUND_GUN_SHOT,

TAMPER,

VISUAL_TAMPER,

MOTION_TAMPER,

MOTION,

MOTION_HUMAN,

MOTION_CAR,

MOTION_ANIMAL,

FACE,

FACE_IDENTIFIED,

FACE_UNIDENTIFIED,

FACE_BLACKLISTED,

FACE_ALERT,

POSE_ANOMALOUS,

POSE_FALL,

LICENSEPLATE,

LICENSEPLATE_IDENTIFIED,

LICENSEPLATE_UNIDENTIFIED,

LICENSEPLATE_ALERT,

LICENSEPLATE_BLACKLISTED,

LICENSEPLATE_TRUSTED,

PEOPLECOUNT_HIGH,

PEOPLECOUNT_HIGH_RESET,

PEOPLECOUNT_LOW,

PEOPLECOUNT_LOW_RESET,

HUMAN_ENTER,

HUMAN_EXIT,

CAR_ENTER,

CAR_EXIT,

TEMPERATURE_EXCEEDED_HIGH,

TEMPERATURE_EXCEEDED_LOW,

HUMIDITY_EXCEEDED_HIGH,

HUMIDITY_EXCEEDED_LOW,

PM25_EXCEEDED_HIGH,

TVOC_EXCEEDED_HIGH,

ETOH_EXCEEDED_HIGH,

IAQ_EXCEEDED_HIGH,

CO2_EXCEEDED_HIGH,

CO2_EXCEEDED_LOW,

PROBE_TEMPERATURE_EXCEEDED_HIGH,

PROBE_TEMPERATURE_EXCEEDED_LOW,

PROBE_DISCONNECTED,

PROBE_CONNECTED,

HEAT_INDEX_EXCEEDED_HIGH,

PRESSURE_EXCEEDED_HIGH,

PRESSURE_EXCEEDED_LOW,

PM10_EXCEEDED_HIGH,

PM40_EXCEEDED_HIGH,

PM100_EXCEEDED_HIGH,

VOC_IDX_EXCEEDED_HIGH,

NOX_IDX_EXCEEDED_HIGH,

FORMALDEHYDE_EXCEEDED_HIGH,

CARBON_MONOXIDE_EXCEEDED_HIGH,

AQI_EXCEEDED_HIGH,

DOOR_AJAR,

DOOR_OPENED,

DOOR_CLOSED,

BUTTON_SINGLE_PRESSED,

BUTTON_DOUBLE_PRESSED,

BUTTON_LONG_PRESSED,

TAG_ARRIVED,

TAG_DEPARTED,

TAG_MOVED,

TAG_POSITIONING_CHANGED,

TAG_BOUNDARY_INGRESS,

TAG_BOUNDARY_EGRESS,

TAG_PANIC,

BADGE_AUTHORIZED,

BADGE_UNAUTHORIZED,

BADGE_UNAUTHORIZED_V2,

BADGE_AJAR,

BADGE_MANUAL,

BADGE_FORCED_OPEN,

BADGE_LOCKDOWN,

BADGE_REQUEST_TO_EXIT,

BADGE_DURESS,

BADGE_SECURITY_BREACH,

BADGE_TAMPER,

BADGE_FACE_MISMATCH,

POS_ORDER,

GUN_DETECT_EVENT,

IOT_SOUND_AGGRESSION,

IOT_SOUND_HELP,

IOT_AIR_CO,

IOT_AIR_CO2,

IOT_AIR_MASKING,

IOT_AIR_THC,

IOT_AIR_VAPE,

IOT_AIR_VOC,

IOT_AIR_TEMP,

IOT_TAMPER,

IOT_GUNSHOT,

IOT_BUTTON_SINGLE_CLICK,

IOT_BUTTON_DOUBLE_CLICK,

IOT_BUTTON_HOLD,

IOT_PANIC_BUTTON_TRIGGERED,

AUDIO_SOUND_SIGNIFICANT,

AUDIO_SOUND_LOUD,

AUDIO_SOUND_ABUSIVE,

AUDIO_SOUND_GREETING,

AUDIO_SOUND_HELP,

AUDIO_SOUND_GUN,

AUDIO_SOUND_GLASS_BREAK,

AUDIO_SOUND_ALARM_SMOKE_FIRE,

AUDIO_SOUND_ALARM_CARBON_MONOXIDE,

AUDIO_SOUND_SIREN,

CLIMATE_VOC,

CLIMATE_VAPE,

CLIMATE_SMOKE,

CLIMATE_THC,

CLIMATE_CO2,

CLIMATE_ETOH,

CLIMATE_PM25,

CLIMATE_IAQ,

CLIMATE_LEAK,

SOUND_AGGRESSION,

SOUND_HELP,

AIR_CO,

AIR_CO2,

AIR_MASKING,

AIR_THC,

AIR_VAPE,

AIR_VOC,

MASK_MISSING,

HELMET_MISSING,

GLOVES_MISSING,

PIR_OCCUPIED,

PIR_MOVEMENT,

PIR_VACANT,

CUSTOM,

VISITOR_ARRIVED,

VISITOR_DEPARTED,

AC_DR_CONNECTED,

AC_DR_DISCONNECTED,

AC_DPI_DOOR_OPEN,

AC_DPI_DOOR_CLOSED,

AC_DPI_DOOR_AJAR,

AC_DPI_DOOR_FORCED_OPEN,

AC_DSR_UNLOCKED,

AC_DSR_LOCKED,

AC_DB_TRIGGERED,

AC_PANIC_BUTTON_TRIGGERED,

AC_REMOTE_UNLOCK,

AC_BADGE_AUTHORIZED,

AC_BADGE_UNAUTHORIZED,

AC_BADGE_FACE_MISMATCH,

AC_LOCKDOWN_ACTIVATED,

AC_LOCKDOWN_DEACTIVATED,

AC_TAMPER_PROX,

AC_TAMPER_ACCEL,

AC_TAMPER_SWITCH,

AC_GR_ACTIVE,

AC_GR_INACTIVE,

AC_GI_ACTIVE,

AC_GI_INACTIVE,

AC_REX_ACTIVE,

AC_REX_INACTIVE,

AC_APERIO_DEVICE_DISCONNECTED,

AC_APERIO_DEVICE_CONNECTED,

AC_APERIO_DEVICE_REBOOT,

AC_APERIO_DEVICE_TAMPER,

AC_APERIO_LOW_BATTERY,

AC_APERIO_FLAT_BATTERY,

AC_APERIO_OK_BATTERY,

POWER_SWITCH_BATTERY,

POWER_SWITCH_PRIMARY,

CUSTOM_LLM_BOOLEAN_TRUE,

CUSTOM_LLM_BOOLEAN_FALSE,

CUSTOM_LLM_THRESHOLD_EXCEEDED_LOW,

CUSTOM_LLM_THRESHOLD_EXCEEDED_HIGH,

ALM_AUTHORITIES_CONTACTED,

ALM_MONITORING_ENABLED,

ALM_MONITORING_DISABLED,

ALM_MONITORING_SETTINGS_CHANGE,

ALM_THREAT_CASE_CLOSED,

ALM_THREAT_DETECTED,

ALM_MONITORING_EVENT_DETECTED,

ROBOT_DOG_DETECTED,

UNKNOWN

deviceUuid

string<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

durationSecs

integer<int32> | null

includeAnyMotion

boolean | null

seekpointDurationIntervalSecs

integer<int32> | null

startTimeSec

integer<int64> | null

Response

200 - application/json

Response object containing seekpoints from camera or doorbell camera events.

combinedSeekpoints

object[] | null

List of combined seekpoints from camera or doorbell camera events

Show child attributes

error

boolean | null

errorMsg

string | null

warningMsg

string | null

Update shared clip page title, description, password, or expiration time Get normal seekpoint events and access control seekpoint events

⌘I

Endpoints

Authorizations

Headers

Body

Response