Documentation for C-Werk 2.0.

Previous page Calendar search API  Triggerings of detection tools Next page

Triggerings of detection tools

Get list of detection tools

GET http://IP-Address:port/prefix/detectors/{VIDEOSOURCEID}

{VIDEOSOURCEID} − first 2 parts of three-component source endpoint ID (see Get list of video cameras and information about them). For instance, "SERVER1/DeviceIpint.1".

Sample request:

GET http://127.0.0.1:80/detectors/SERVER1/DeviceIpint.1

Sample response:

{
    "detectors": [
        {
            "name": "hosts/SERVER1/AVDetector.1/EventSupplier",
            "type": "SceneDescription"
        },
        {
            "name": "hosts/SERVER1/AVDetector.12/EventSupplier",
            "type": "NullAudioDetection"
        }
    ]
}

Attention!

The type field is deprecated. To get up-to-date information on detection tools, it is recommended to use the /camera/list request (see Get list of video cameras and information about them).

Available values of type parameter:

typeDetection tool
SceneDescription
Scene Analytics detection tools 
CrossOneLineLine crossing
moveInZoneMotion in area
StopInZoneStop in area
ComeInZoneAppearance in area
OutOfZoneDisappearance in area
LongInZoneLoitering
lostObjectMultiple objects
LprDetectorNumber Plate Recognition
TvaFaceDetectorFace detection
PeopleCounterVisitors counter
QueueDetectorQueue detection
FireDetector
Fire detection
SmokeDetector
Smoke detection
NeuroCounterNeural counting
SceneChange
Position change
QualityDegradation_v2
Image Noise Detection
QualityDegradation
Loss of quality
BlurredDegradation
Blurred Image Detection
CompressedDegradation
Compression Artifacts Detection
MotionDetection
Motion detection
NullAudioDetection
No signal
SignalAudioDetection
Signal
NoiseAudioDetection
Noise
PoseDetectorPose detection
RecumbentDetectorMan down detection
SitDownDetectorSitting person detection
HandsUpDetectorHands up detection
WaterLevelDetectorWater level detection
HandRailDetectorHandrail holding detection
PeopleCountDetectorBySkeletonPeople counter
PeopleDistanceDetectorClose-standing people detection
PoseMaskingDetectorPeople masking

Get list of detection tools events

GET http://IP-Address:port/prefix/archive/events/detectors/{ENDTIME}/{BEGINTIME}get detections from all Domain Servers.

Attention!

The ENDTIME and BEGINTIME syntax is described in Get archive contents.

If ENDTIME < BEGINTIME in the request, then the events in the response will be sorted by time in ascending order.

If ENDTIME > BEGINTIME, then the events will be sorted in descending order.

GET http://IP-Address:port/prefix/archive/events/detectors/{HOSTNAME}/{ENDTIME}/{BEGINTIME}get detections from a certain Server.

{HOSTNAME}Server name (see Get Server list).

GET http://IP-Address:port/prefix/archive/events/detectors/{VIDEOSOURCEID}/{ENDTIME}/{BEGINTIME}get detections from a certain camera.

{VIDEOSOURCEID}three-component source endpoint ID (see Get list of video cameras and information about them). For instance, "SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0".

ParameterRequiredDescription
limitNoLimit of detections in the response. If not specified, it is equal to 100
offsetNoThe results offset by the specified number. For example, if a query with offset=0 returned 100 results, then in order to get the next results, it is necessary to run a query with offset=100. If the second query returned 250 results, then in order to get the next results, it is necessary to run a query with offset=350, etc.
typeNo

Get detections from a certain detection tool. The values of the type parameter are listed in the table below.

If you need to get detections from several detection tools, you need to list them separated by commas

joinNo

If join=1, then in the response, the two-phase events will be merged together, and the duration parameter will be returned which corresponds to the event duration.

If join=0, then in the response, the two-phase events will not be merged together

limit_to_archiveNo

If limit_to_archive=1, then the response will return the events only from the accessible part of the archive (see Configuring access restrictions to archive)

archiveNo

The name of the archive from the request to receive the list of archives (see Get archive contents)

detectorNo

Get detections from a certain detection tool. The values of the detector parameter are listed in the table below

Sample requests:

  • http://127.0.0.1:80/archive/events/detectors/Server1/DeviceIpint.2/SourceEndpoint.video:0:0/past/future?limit=10&offset=0get detections from a certain camera, sorted in descending order. The maximum limit is 10.
  • http://127.0.0.1:80/archive/events/detectors/Server1/past/future?limit=5&offset=0get detections from all detection tools of Server1. The maximum limit for each detection tool is 5.
  • http://127.0.0.1:80/archive/events/detectors/Server1/past/future?limit=5&offset=0&type=Rayget detections from all sensors of Server1. The maximum limit for each sensor is 5.
  • http://127.0.0.1:80/archive/events/detectors/Host/DeviceIpint.1/SourceEndpoint.video:0:0/future/past?limit=100&detector=hosts/Server1/AVDetector.1/EventSupplier—get detections from a certain detection tool of Server1.
  • http://root:root@127.0.0.1:80/archive/events/detectors/Server1/DeviceIpint.1/SourceEndpoint.video:0:0/20230323T112000.000/20230430T210000.000?limit=100&offset=0&type=listed_face_detected,MotionDetected—get detections from several detection tools of Server1. The detection tools must be listed separated by commas.
  • http://127.0.0.1:80/archive/events/detectors/past/future?limit=1&type=Rayget the current state of all sensors of the Domain.

Attention!

It is recommended to use the past/future parameter only in the first request. Then you should get the timestamp of the most recent record and use it to request subsequent records. Using the past/future parameter along with the limit and offset parameters in subsequent requests can result in duplicate records.

Sample response:

1) join=1

{
    "events": [
        {
            "duration": "000000.467000",
            "id": "09b8729a-a6fc-4ffa-8a83-aebc5c19d171",
            "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
            "rectangles": [
                {
                    "bottom": "0.20831976890563964",
                    "index": "0",
                    "left": "0.57320795059204099",
                    "right": "0.6804207420349121",
                    "top": "0.09125151634216308"
                }
            ],
            "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp": "20190618T112815.527000",
            "type": "moveInZone"
        },
        {
            "duration": "000004.154000",
            "id": "90c5d09e-c0bb-4c49-bf8b-22d3afffe8c1",
            "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
            "rectangles": [
                {
                    "bottom": "0.72451157569885249",
                    "index": "0",
                    "left": "0.092941055297851571",
                    "right": "0.24284084320068361",
                    "top": "0.4965816402435303"
                }
            ],
            "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp": "20190618T112814.426000",
            "type": "moveInZone"
        },
        {
            "duration": "000005.155000",
            "id": "dc953fad-bb08-4bae-bdce-62a09ab2dbd9",
            "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
            "rectangles": [
                {
                    "bottom": "0.37916545867919921",
                    "index": "0",
                    "left": "0.10621988296508789",
                    "right": "0.2311831474304199",
                    "top": "0.11115360260009766"
                }
            ],
            "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp": "20190618T112814.293000",
            "type": "moveInZone"
        },
        {
            "duration": "000003.170000",
            "id": "f00875f0-bad7-4e74-879c-0a564baa9d36",
            "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
            "rectangles": [
                {
                    "bottom": "0.2848846626281738",
                    "index": "0",
                    "left": "0.11811468601226806",
                    "right": "0.18662774562835693",
                    "top": "0.11245393753051756"
                }
            ],
            "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp": "20190618T112813.358000",
            "type": "moveInZone"
        }
    ],
    "more": true
}

2) join=0

{
 "events": [
  {
   "alertState": "ended",
   "id": "cd3571bb-73c1-45cb-8965-a01e167836db",
   "multiPhaseSyncId": "6d72973d-7188-4fa7-9bf9-e3ba6013f2e3",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T125142.417000",
   "type": "moveInZone"
  },
  {
   "alertState": "began",
   "id": "310ce582-5f0d-4c27-a1d5-b14ccc5a877d",
   "multiPhaseSyncId": "6d72973d-7188-4fa7-9bf9-e3ba6013f2e3",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [
    {
     "bottom": "0.46943313598632813",
     "index": "0",
     "left": "0.14642228603363036",
     "right": "0.23025640964508054",
     "top": "0.027766456604003897"
    }
   ],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T125142.200000",
   "type": "moveInZone"
  },
  {
   "alertState": "began",
   "id": "aa193bbc-89e8-4204-8805-ac8c915b323c",
   "multiPhaseSyncId": "807248bf-4cee-431e-a29f-18ee0ed911ce",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [
    {
     "bottom": "0.36835212707519532",
     "index": "0",
     "left": "0.072501201629638662",
     "right": "0.19335731506347656",
     "top": "0.03212909698486327"
    }
   ],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T125141.966000",
   "type": "moveInZone"
  },
  {
   "alertState": "ended",
   "id": "5b15234d-2a7f-415f-af57-2ac1ce5aa75a",
   "multiPhaseSyncId": "17fca913-f7a3-4f29-997f-d02a575d9fc4",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T125136.978000",
   "type": "moveInZone"
  },
  {
   "alertState": "ended",
   "id": "48882f92-a809-424c-b7a7-55ac56b05061",
   "multiPhaseSyncId": "8bb9edbe-4391-4c26-8c7a-7faf620a62eb",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T125136.661000",
   "type": "moveInZone"
  },
  {
   "alertState": "ended",
   "id": "6e98f979-c4f4-4c78-bbf4-6fc268219d79",
   "multiPhaseSyncId": "92534e2f-0f88-4698-a1a2-4e70d10cb00a",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T125136.477000",
   "type": "moveInZone"
  },
  {
   "alertState": "ended",
   "id": "c9dff8bc-423b-414b-8dee-0a0b119a43df",
   "multiPhaseSyncId": "c8785151-f344-4c21-88de-6c339139afdf",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T125135.843000",
   "type": "moveInZone"
  },
  {
   "alertState": "ended",
   "id": "db1f1147-ed50-46ff-84b7-8f06676d8f8e",
   "multiPhaseSyncId": "7eceb0b4-c04d-4e17-a405-3aff419fd94a",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T125135.677000",
   "type": "moveInZone"
  },
  {
   "alertState": "began",
   "id": "f9ccceda-9e16-4832-9f1f-1270fd0be365",
   "multiPhaseSyncId": "17fca913-f7a3-4f29-997f-d02a575d9fc4",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [
    {
     "bottom": "0.30296741485595702",
     "index": "0",
     "left": "0.14849423646926879",
     "right": "0.21262614011764525",
     "top": "0.092105445861816404"
    }
   ],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T125135.677000",
   "type": "moveInZone"
  },
  {
   "alertState": "began",
   "id": "87ca4e1e-4a8c-433a-8b67-6e73f65fa0e2",
   "multiPhaseSyncId": "7eceb0b4-c04d-4e17-a405-3aff419fd94a",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [
    {
     "bottom": "0.22597263336181642",
     "index": "0",
     "left": "0.080717468261718744",
     "right": "0.19577339172363281",
     "top": "0.014194698333740235"
    }
   ],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T125134.909000",
   "type": "moveInZone"
  }
 ],
 "more": true
}                             

Attention!

By default, the request timeout is 10 seconds.

If the Server fails to return all events (the quantity is set in the limit parameter) in 10 seconds, the response will be as follows:

{
   "events": [],
   "more": false
}

In this case, it is necessary to repeat the request and reduce the value of the limit parameter.


Note

The multiPhaseSyncId parameter will be in the response only for two-phase alarms with alertState parameter.

Field timestamp is not unique so it might be necessary to skip the previously received alarms starting from the search interval.

When requesting the queue detection tool triggerings, the response will include an additional extra parameter that will contain the queue length estimate expressed by the minimum and maximum values.

       {
            "alertState": "happened",
            "extra": [
                {
                    "queueMax": "4"
                },
                {
                    "queueMin": "4"
                }
            ],
            "id": "b17129b2-1588-794b-94f6-d078a226efb2",
            "origin": "hosts/Server1/AVDetector.4/EventSupplier",
            "rectangles": [],
            "source": "hosts/Server1/DeviceIpint.2/SourceEndpoint.video:0:0",
            "timestamp": "20181206T075621.621000",
            "type": "QueueDetected"
        }
}

When requesting the detections from License plate recognition, the response will include an additional plate parameter that will contain the recognized license plate in Unicode format.

  "alertState" : "happened",
            "id" : "f1f334a3-3fb3-4770-80bf-c6519240b5cf",
            "origin" : "hosts/Server1/AVDetector.1/EventSupplier",
            "plate" : "\u0045\u0041\u0033",
            "rectangles" :
            [
                {
                    "bottom" : 0.70833333333333337,
                    "index" : 0,
                    "left" : 0.4597222222222222,
                    "right" : 0.67222222222222228,
                    "top" : 0.64409722222222221
                }
            ],
            "source" : "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp" : "20230725T140945.208000",
            "type" : "plateRecognized"
        }

Possible values of the type parameter:

Detection tooltype
Scene Analytics detection tools
Line crossingoneLine
Motion in areamoveInZone
Stop in areastopInZone
Appearance in areacomeInZone
Disappearance in areaoutOfZone
LoiteringlongInZone
Multiple objectslostObject
Number Plate RecognitionplateRecognized
Number Plate Recognition (from the list)listed_lpr_detected
Face detectionfaceAppeared
Face detection (from the list)listed_face_detected
Visitors counterPeopleIn, PeopleOut
Queue detectionQueueDetected
Fire detectionFireDetected
Smoke detectionSmokeDetected
Neural countinglotsObjects
Position changeSceneChangeDetected
Image Noise DetectionCameraBlindDetected
Loss of qualityImageDegradation
Blurred Image DetectionBlurredDegradation
Compression Artifacts DetectionCompressedDegradation
Motion detectionMotionDetected
No signalNullAudio
SignalSignalAudio
Noise

NoiseAudio

Pose detection
Man down detectionrecumbent
Sitting person detectionsitDown
Hands up detectionhandsUp
Water level detectionLevelOut
Handrail holding detectionhandRail
People counterlotsObjects
Close-standing people detectionpeopleDistance
People maskingenabledMaskEvents

Possible values of the detector parameter:

detector

Detection tool
SceneDescriptionScene Analytics detection tools
CrossOneLineLine crossing
moveInZoneMotion in area
StopInZoneStop in area
ComeInZoneAppearance in area
OutOfZoneDisappearance in area
LongInZoneLoitering
lostObjectMultiple objects
LprDetectorNumber Plate Recognition
TvaFaceDetectorFace detection
PeopleCounterVisitors counter
QueueDetectorQueue detection
FireDetectorFire detection
SmokeDetectorSmoke detection
NeuroCounterNeural counting
SceneChangePosition change
QualityDegradationLoss of quality
QualityDegradation_v2

Image Noise Detection

BlurredDegradationBlurred Image Detection
CompressedDegradationCompression Artifacts Detection
MotionDetectionMotion detection
NullAudioDetectionNo signal
SignalAudioDetectionSignal
NoiseAudioDetection

Noise

PoseDetectorPose detection
RecumbentDetectorMan down detection
SitDownDetectorSitting person detection
HandsUpDetectorHands up detection
ActiveShooterDetectorShooter detection
WaterLevelDetectorWater level detection
HandRailDetectorHandrail holding detection
PeopleCountDetectorBySkeletonPeople counter
PeopleDistanceDetectorClose-standing people detection
PoseMaskingDetectorPeople masking

Attention!

  • Case sensitivity of detection tool triggering types is not guaranteed. For instance, 'ComeInZone', 'comeInZone' and 'COMEINZOne' values are to be considered as the same ones.
  • If you received a value not included in the list, then an embedded detection tool triggered.

Get audit events from system log

GET http://IP-Address:port/prefix/audit/{HOSTNAME}/{ENDTIME}/{BEGINTIME}

{HOSTNAME} − Server name.

Note

The ENDTIME and BEGINTIME syntax is described in Get archive contents section.

Attention!

If ENDTIME < BEGINTIME in the request, then the events in the response will be sorted by time in ascending order.

If ENDTIME > BEGINTIME, then the events will be sorted in descending order.

ParametrRequiredDescription

filter

No

List of events that can be represented both as a range separated with <-> and <:> and a simple code.

The list of event types:

1 − not shown in the event log
2 − violation of BOT of audit events (e.g., it is edged manually)
3 − violation of EOT of audit events (e.g., it is edged manually)
4 − some audit events are absent (e.g., they are deleted manually)
5 − table entry is changed
6 − inactive log (no events or log update mark)
/// External events
7 − user is added
8 − user is deleted
9 − user parameters are changed
10 − role is added
11 − role is deleted
12 − role parameters are changed
13 − user login
14 − user logout
15 − device is added
16 − device is deleted
17 − device parameters are changed
18 − detection is added
19 − detection is deleted
20 − detection parameters are changed
21 − archive is added
22 − archive is deleted
23 − archive parameters are changed
24 − detection rule (macro) is created
25 − detection rule (macro) is deleted
26 − detection rule (macro) parameters are changed
27 − alarm is triggered
28 − zone is armed
29 − zone is disarmed
30 − export from archive is performed
31 − notification sender (sound-, email-) is added
32 − notification sender is deleted
33 − notification sender parameters are changed
34 − general parameter is changed
35 − recording to the archive parameters are changed
36 − agent of export is added
37 − agent of export is deleted
38 − agent of export parameters are changed
39 − macro is created
40 − macro is deleted
41 − macro parameters are changed
42 − alarm is processed by user
43 − dangerous alarm
44 − suspicious alarm
45 − false alarm
46 − skipped alarm
47 − Server is included into Domain
48 − Server is excluded from Domain
49 − view archive
50 − view camera
51 − view layout
52 − forensic search in the archive
53 − area search by faces in the archive
54 − area search by license plates in the archive
55 − system log export
56 − LDAP folder is added
57 − LDAP folder is deleted
58 − LDAP folder parameters are changed
59 − layout created
60 − layout removed
61 − layout changed
62 − user login failed
63 − PTZ control
64 − archive comment added
65 − archive comment changed
66 − license expired
67 − logout due to user inaction
68 − client blocked due to user inaction
69 − client unlocked by user
70 − client blocked by user
71 − unexpected client shut-down

Sample request:

GET http://127.0.0.1:80/audit/SERVER1/past/future?filter=17-20,6,1:4

Sample response:

{
  "events": [
    {
      "data": {
        "component": "Camera3",
        "componentType": "camera",
        "device": "Camera3",
        "host": "SERVER1",
        "property": "vstream-virtual/folder",
        "setting": "Directory",
        "value": "D:/Movies/Spirit"
      },
      "eventType": 17,
      "timestamp": "20161205T120410.698000"
    },
    {
      "data": {
        "detector": "Face detection",
        "device": "Camera1",
        "host": "SERVER1"
      },
      "eventType": 18,
      "timestamp": "20161205T120459.319000"
    }
  ]
}

Get list of alarms

GET http://IP-Address:port/prefix/archive/events/alerts/{ENDTIME}/{BEGINTIME} − get alarms from all Domain Servers.

Note

The ENDTIME and BEGINTIME syntax is described in Get archive contents section.

Attention!

If ENDTIME < BEGINTIME in the request, then the events in the response will be sorted by time in ascending order.

If ENDTIME > BEGINTIME, then the events will be sorted in descending order.

GET http://IP-Address:port/prefix/archive/events/alerts/{HOSTNAME}/{ENDTIME}/{BEGINTIME} − get alarms from a certain Server.

{HOSTNAME} Server name (see Get Server list).

GET http://IP-Address:port/prefix/archive/events/alerts/{VIDEOSOURCEID}/{ENDTIME}/{BEGINTIME} − get alarms from a certain camera.

{VIDEOSOURCEID} three-component source endpoint ID (see Get list of video cameras and information about them). For instance, "SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0".

ParameterRequiredDescription
limitNo

The limit of alarms in the response. If not specified, it is equal to 100 by default.

offsetNo

The results offset by the specified number. For example, if a query with offset=0 returned 100 results, then in order to get the next results, it is necessary to run a query with offset=100. If the second query returned 250 results, then in order to get the next results, it is necessary to run a query with offset=350, etc.

limit_to_archiveNo

If limit_to_archive=1, then the response will return the events only from the accessible part of the archive (see Configuring access restrictions to archive).

archiveNo

The name of the archive from the request to receive the list of archives (see Get archive contents).

Sample request:

GET http://127.0.0.1:80/archive/events/alerts/Server1/past/future?limit=50&offset=0

Sample response:

{
    "events": [
        {
            "type": "alert",
            "id": "2bb7f765-eb57-604d-a38c-d1d26d22e4d9",
            "raisedAt": "20181219T151437.312808",
            "zone": "hosts/DESKTOP-O0P0IBQ/DeviceIpint.1/SourceEndpoint.video:0:0",
            "reasons": [
                "ruleAlert",
                "videoDetector"
            ],
            "initiator": "faceAppeared",
            "reaction": {
                "user": "",
                "reactedAt": "20181219T151937.342036",
                "severity": "unclassified"
            },
            "detectorName": "1.Face detection",
            "rectangles": [
                {
                    "index": "47",
                    "left": "0,85343749999999996",
                    "top": "0,37958333333333333",
                    "right": "1",
                    "bottom": "0,58083333333333331"
                }
            ]
        },
        {
            "type": "alert",
            "id": "03c0d49f-5475-684e-a622-2aaeac303508",
            "raisedAt": "20181219T151005.933417",
            "zone": "hosts/DESKTOP-O0P0IBQ/DeviceIpint.1/SourceEndpoint.video:0:0",
            "reasons": [
                "ruleAlert",
                "videoDetector"
            ],
            "initiator": "faceAppeared",
            "reaction": {
                "user": "root",
                "reactedAt": "20181219T151013.109256",
                "severity": "alarm"
            },
            "detectorName": "1.Face detection",
            "rectangles": [
                {
                    "index": "9",
                    "left": "0,83406249999999993",
                    "top": "0,36416666666666664",
                    "right": "1",
                    "bottom": "0,58583333333333332"
                }
            ]
        },
        {
            "type": "alert",
            "id": "6d396f93-4acf-c54b-a26e-c1ab178bdb06",
            "raisedAt": "20181219T150911.101417",
            "zone": "hosts/DESKTOP-O0P0IBQ/DeviceIpint.1/SourceEndpoint.video:0:0",
            "reasons": [
                "userAlert"
            ],
            "initiator": "root",
            "reaction": {
                "user": "root",
                "reactedAt": "20181219T150916.264631",
                "severity": "alarm"
            },
            "detectorName": "",
            "rectangles": []
        }
    ],
    "more": false
}
ParameterDescription
raisedAt

Field raisedAt is not unique so it might be necessary to skip the previously received alarms starting from the search interval.

reasons

Possible values of the reasons array: armed, disarmed, userAlert, ruleAlert, videoDetector, audioDetector, ray.

severity

Possible values of the severity field: unclassified, false, notice, warning, alarm.

initiator

Possible values of the initiator field:

  1. Name of the user initiated the alarm.
  2. Id of the macro (see Using macros) if the alarm is initiated by macro that was started NOT by the detector (even if this macro has already been removed from the configuration).
  3. Type of detector that triggered macro that initiated the alarm (see Get list of detection tools events).

Content

  • No labels