Event Search

Get normal seekpoint events and access control seekpoint events deprecated

Get normal seekpoint events and access control seekpoint events

Warning

This operation is deprecated: it is kept for existing integrations; avoid it in new code.

POST/api/eventSearch/getEventSeekpoints

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for retrieving event seekpoints with various search criteria and filtering options.

activitySetenum<string>[] | nullbody

Set of activity types to filter seekpoints by

componentSeekPointsByAccessControlledDoorWSRequestobjectbody

Component seekpoints search for access controlled door

Show child attributes

accessControlledDoorUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

durationSecinteger<int32> | nullbody

startTimeSecEpochExclusiveinteger<int64> | nullbody

componentSeekPointsByAccessControlledDoorsWSRequestobjectbody

Component seekpoints search for access controlled doors

Show child attributes

accessControlledDoorUuidListstring<RUUID>[] | nullbody

durationSecinteger<int32> | nullbody

sortResponseboolean | nullbody

startTimeSecEpochExclusiveinteger<int64> | nullbody

componentSeekPointsByOwnerDeviceWSRequestobjectbody

Component seekpoints search for owner device

Show child attributes

durationSecinteger<int32> | nullbody

ownerDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

startTimeSecEpochExclusiveinteger<int64> | nullbody

durationSecinteger<int32> | nullbody

Duration in seconds for the search window

Example: 3600

searchColorAndVehicleByColorWSRequestobjectbody

Request object for searching clothing and vehicle events by color with time and device filtering.

Show child attributes

clothingColorFilterenum<string>[] | nullbody

Set of clothing colors to filter the search by

deviceFilterstring<DeviceFacetUuid>[] | nullbody

List of device UUIDs to filter the search by

endTimeMsinteger<int64> | nullbody

End time in milliseconds for the search window

Example: 1641081600000

startTimeMsinteger<int64> | nullbody

Start time in milliseconds for the search window

Example: 1640995200000

vehicleColorFilterenum<string>[] | nullbody

Set of vehicle colors to filter the search by

searchMotionGridWithActivitiesWSRequestobjectbody

Request object for searching motion grid data with activity information.

Show child attributes

deviceUuidstring<DeviceFacetUuid> | nullbodyrequired

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

endTimeUtcSecsinteger<int64> | nullbodyrequired

End time as a UNIX timestamp in seconds

Example: 1641081600

searchCellsobject[] | nullbodyrequired

List of motion grid cells to include in the search

Show child attributes

colinteger<int32> | nullbody

Column coordinate of the cell

Example: 5

rowinteger<int32> | nullbody

Row coordinate of the cell

Example: 3

startTimeUtcSecsinteger<int64> | nullbodyrequired

Start time as a UNIX timestamp in seconds

Example: 1640995200

seekpointsWSRequestobjectbody

General seekpoints search request parameters

Show child attributes

deviceUuidstring<DeviceFacetUuid> | nullbody

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

durationSecsinteger<int32> | nullbody

includeAnyMotionboolean | nullbody

startTimeSecinteger<int64> | nullbody

Start time in seconds for the search window

Example: 1640995200

videoFootageWSRequestobjectbody

Request object for video footage search with camera selection and multi-camera options.

Show child attributes

cameraUuidstring<DeviceFacetUuid> | nullbody

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

cameraUuidsstring<DeviceFacetUuid>[] | nullbody

List of camera UUIDs to search for video footage

durationinteger<int32> | nullbody

Duration in seconds

Example: 3600

includeAnyMotionboolean | nullbody

Whether to include any motion events

Example: true

startTimeinteger<int64> | nullbody

Start time in seconds since epoch

Example: 1640995200

useMultiCameraboolean | nullbody

Whether to use multi-camera search functionality

Example: true

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/eventSearch/getEventSeekpoints' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "activitySet": [
      "SOUND_LOUD"
    ],
    "componentSeekPointsByAccessControlledDoorWSRequest": {
      "accessControlledDoorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "durationSec": 0,
      "startTimeSecEpochExclusive": 0
    },
    "componentSeekPointsByAccessControlledDoorsWSRequest": {
      "accessControlledDoorUuidList": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "durationSec": 0,
      "sortResponse": true,
      "startTimeSecEpochExclusive": 0
    },
    "componentSeekPointsByOwnerDeviceWSRequest": {
      "durationSec": 0,
      "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "startTimeSecEpochExclusive": 0
    },
    "durationSec": 3600,
    "searchColorAndVehicleByColorWSRequest": {
      "clothingColorFilter": [
        "GREEN"
      ],
      "deviceFilter": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "endTimeMs": 1641081600000,
      "startTimeMs": 1640995200000,
      "vehicleColorFilter": [
        "GREEN"
      ]
    },
    "searchMotionGridWithActivitiesWSRequest": {
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "endTimeUtcSecs": 1641081600,
      "searchCells": [
        {
          "col": 5,
          "row": 3
        }
      ],
      "startTimeUtcSecs": 1640995200
    },
    "seekpointsWSRequest": {
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "durationSecs": 0,
      "includeAnyMotion": true,
      "startTimeSec": 0
    },
    "startTimeSec": 1640995200,
    "videoFootageWSRequest": {
      "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "cameraUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "duration": 3600,
      "includeAnyMotion": true,
      "startTime": 1640995200,
      "useMultiCamera": true
    }
  }'

import requests

url = "https://api2.rhombussystems.com/api/eventSearch/getEventSeekpoints"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "activitySet": [
        "SOUND_LOUD"
    ],
    "componentSeekPointsByAccessControlledDoorWSRequest": {
        "accessControlledDoorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "durationSec": 0,
        "startTimeSecEpochExclusive": 0
    },
    "componentSeekPointsByAccessControlledDoorsWSRequest": {
        "accessControlledDoorUuidList": [
            "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "durationSec": 0,
        "sortResponse": True,
        "startTimeSecEpochExclusive": 0
    },
    "componentSeekPointsByOwnerDeviceWSRequest": {
        "durationSec": 0,
        "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "startTimeSecEpochExclusive": 0
    },
    "durationSec": 3600,
    "searchColorAndVehicleByColorWSRequest": {
        "clothingColorFilter": [
            "GREEN"
        ],
        "deviceFilter": [
            "AAAAAAAAAAAAAAAAAAAAAA.v0"
        ],
        "endTimeMs": 1641081600000,
        "startTimeMs": 1640995200000,
        "vehicleColorFilter": [
            "GREEN"
        ]
    },
    "searchMotionGridWithActivitiesWSRequest": {
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
        "endTimeUtcSecs": 1641081600,
        "searchCells": [
            {
                "col": 5,
                "row": 3
            }
        ],
        "startTimeUtcSecs": 1640995200
    },
    "seekpointsWSRequest": {
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
        "durationSecs": 0,
        "includeAnyMotion": True,
        "startTimeSec": 0
    },
    "startTimeSec": 1640995200,
    "videoFootageWSRequest": {
        "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
        "cameraUuids": [
            "AAAAAAAAAAAAAAAAAAAAAA.v0"
        ],
        "duration": 3600,
        "includeAnyMotion": True,
        "startTime": 1640995200,
        "useMultiCamera": True
    }
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/eventSearch/getEventSeekpoints', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "activitySet": [
      "SOUND_LOUD"
    ],
    "componentSeekPointsByAccessControlledDoorWSRequest": {
      "accessControlledDoorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "durationSec": 0,
      "startTimeSecEpochExclusive": 0
    },
    "componentSeekPointsByAccessControlledDoorsWSRequest": {
      "accessControlledDoorUuidList": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "durationSec": 0,
      "sortResponse": true,
      "startTimeSecEpochExclusive": 0
    },
    "componentSeekPointsByOwnerDeviceWSRequest": {
      "durationSec": 0,
      "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "startTimeSecEpochExclusive": 0
    },
    "durationSec": 3600,
    "searchColorAndVehicleByColorWSRequest": {
      "clothingColorFilter": [
        "GREEN"
      ],
      "deviceFilter": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "endTimeMs": 1641081600000,
      "startTimeMs": 1640995200000,
      "vehicleColorFilter": [
        "GREEN"
      ]
    },
    "searchMotionGridWithActivitiesWSRequest": {
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "endTimeUtcSecs": 1641081600,
      "searchCells": [
        {
          "col": 5,
          "row": 3
        }
      ],
      "startTimeUtcSecs": 1640995200
    },
    "seekpointsWSRequest": {
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "durationSecs": 0,
      "includeAnyMotion": true,
      "startTimeSec": 0
    },
    "startTimeSec": 1640995200,
    "videoFootageWSRequest": {
      "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "cameraUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "duration": 3600,
      "includeAnyMotion": true,
      "startTime": 1640995200,
      "useMultiCamera": true
    }
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "activitySet": [
                "SOUND_LOUD"
              ],
              "componentSeekPointsByAccessControlledDoorWSRequest": {
                "accessControlledDoorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                "durationSec": 0,
                "startTimeSecEpochExclusive": 0
              },
              "componentSeekPointsByAccessControlledDoorsWSRequest": {
                "accessControlledDoorUuidList": [
                  "AAAAAAAAAAAAAAAAAAAAAA"
                ],
                "durationSec": 0,
                "sortResponse": true,
                "startTimeSecEpochExclusive": 0
              },
              "componentSeekPointsByOwnerDeviceWSRequest": {
                "durationSec": 0,
                "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                "startTimeSecEpochExclusive": 0
              },
              "durationSec": 3600,
              "searchColorAndVehicleByColorWSRequest": {
                "clothingColorFilter": [
                  "GREEN"
                ],
                "deviceFilter": [
                  "AAAAAAAAAAAAAAAAAAAAAA.v0"
                ],
                "endTimeMs": 1641081600000,
                "startTimeMs": 1640995200000,
                "vehicleColorFilter": [
                  "GREEN"
                ]
              },
              "searchMotionGridWithActivitiesWSRequest": {
                "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
                "endTimeUtcSecs": 1641081600,
                "searchCells": [
                  {
                    "col": 5,
                    "row": 3
                  }
                ],
                "startTimeUtcSecs": 1640995200
              },
              "seekpointsWSRequest": {
                "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
                "durationSecs": 0,
                "includeAnyMotion": true,
                "startTimeSec": 0
              },
              "startTimeSec": 1640995200,
              "videoFootageWSRequest": {
                "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
                "cameraUuids": [
                  "AAAAAAAAAAAAAAAAAAAAAA.v0"
                ],
                "duration": 3600,
                "includeAnyMotion": true,
                "startTime": 1640995200,
                "useMultiCamera": true
              }
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/eventSearch/getEventSeekpoints"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

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

Response

200 OK

application/json · object

Response object containing combined seekpoints from various event sources.

combinedSeekpointsobject[] | null

List of combined seekpoints from various event sources

Show child attributes

activityenum<string>

Available options: SOUND_LOUD, SOUND_GUN_SHOT, TAMPER, VISUAL_TAMPER, MOTION_TAMPER, MOTION, MOTION_HUMAN, MOTION_CAR, MOTION_ANIMAL, MOTION_PACKAGE, PACKAGE_ARRIVED, PACKAGE_DEPARTED, 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_LOCKDOWN_PLAN_SWITCHED, 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, AC_SCHLAGE_GW_DISCONNECTED, AC_SCHLAGE_GW_CONNECTED, AC_SCHLAGE_APM_DISCONNECTED, AC_SCHLAGE_APM_CONNECTED, AC_SCHLAGE_LOW_BATTERY, AC_SCHLAGE_CRITICAL_BATTERY, AC_SCHLAGE_OK_BATTERY, POWER_SWITCH_BATTERY, POWER_SWITCH_PRIMARY, AI_SEARCH_MATCH, AI_SEARCH_MATCH_PERSON_SMOKING, AI_SEARCH_MATCH_PERSON_ON_PHONE, AI_SEARCH_MATCH_PERSON_FALLING, 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, ROBOT_ARRIVED_AT_WAYPOINT, ROBOT_ARRIVED_AT_POSE, ROBOT_WAITING_AT_POSE, ROBOT_MANUAL_CMD_VEL, ROBOT_MANUAL_ACTION, ROBOT_MANUAL_POSTURE, ROBOT_NAVIGATE_TO_POSE_START, ROBOT_NAVIGATE_TO_POSE_END, ROBOT_NAVIGATE_TO_HOME_START, ROBOT_NAVIGATE_TO_HOME_END, ROBOT_NAVIGATE_TO_WAYPOINT_START, ROBOT_NAVIGATE_TO_WAYPOINT_END, ROBOT_ROUTE_RUN_START, ROBOT_ROUTE_RUN_END, ROBOT_LOW_BATTERY_DOCKING, ROBOT_IDLE_DOCKING, ROBOT_EMERGENCY, LOITER_HUMAN, INACTIVITY_HUMAN, INACTIVITY_CAR, GROUP_ENTRY, ONGUARD_BADGE_AUTHORIZED, ONGUARD_BADGE_ANOMALY, ONGUARD_NO_ENTRY_MADE, ELEMENTS_BADGE_AUTHORIZED, ELEMENTS_BADGE_ANOMALY, ELEMENTS_NO_ENTRY_MADE, NETBOX_BADGE_AUTHORIZED, NETBOX_BADGE_ANOMALY, NETBOX_NO_ENTRY_MADE, THERMAL_TEMPERATURE_ALARM, THERMAL_TEMPERATURE_WARNING, THERMAL_FIRE_DETECTED, THERMAL_SMOKING_DETECTED, THERMAL_FIRE_VERIFIED, THERMAL_HEAT_NO_THREAT, THERMAL_VISUAL_HOTSPOT, THERMAL_VISUAL_HEAT_RISE, THERMAL_VISUAL_WARM_BODY, UNKNOWN

cameraUuidstring<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

cardholderNamestring | null

Cardholder (badge holder) name for OnGuard integration seekpoints

Example: "Jane Doe"

customActivityColorenum<string>

Available options: BLUE, RED, PURPLE, TAN, ORANGE, TEAL, GRAY, BLACK

customActivityDescriptionstring | null

Custom description for the activity

Example: "A person was detected in the camera view"

customActivityDisplayNamestring | null

Custom display name for the activity

Example: "Person Detected"

dwellingboolean | null

Whether the detected person is dwelling/loitering

faceNamestring | null

Name of the face detected in this seekpoint

Example: "John Doe"

licensePlatestring | null

License plate detected in this seekpoint

Example: "ABC123"

objectIdinteger<int32> | null

Object ID for tracking purposes

Example: 12345

originalEventobject | null

Original event object that generated this seekpoint

regionMatchTimestampMsinteger<int64> | null

Timestamp in milliseconds of the earliest motion evidence inside the searched region for this seekpoint. Only populated when the request includes searchCells and this seekpoint matched the region. May trail timestampMs, which reflects the start of the underlying motion event rather than when the region was entered.

Example: 1640995215000

seekpointEndTimeMsinteger<int64> | null

End time in milliseconds for the seekpoint duration

Example: 1640995300000

seekpointStartTimeMsinteger<int64> | null

Start time in milliseconds for the seekpoint duration

Example: 1640995200000

stableTrackIdinteger<int32> | null

Stable track ID for re-identification across track segments

Example: 42

thumbnailUrlstring | null

URL to the thumbnail image for this seekpoint

Example: "https://example.com/thumbnail.jpg"

timestampMsinteger<int64> | null

Timestamp in milliseconds when the seekpoint occurred

Example: 1640995200000

unidentifiedFaceIdstring | null

ID for unidentified faces

Example: "face_12345"

errorboolean | null

errorCodestring | null

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

errorMsgstring | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.