Go to documentation repository
Documentation for Axxon One 2.0. Documentation for other versions of Axxon One is available too.
Previous page Next page
GET http://IP address:port/prefix/archive/events/detectors/{ENDTIME}/{BEGINTIME}—get events from detectors from all Axxon-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 are sorted by time in ascending order.
If ENDTIME > BEGINTIME, then the events are sorted in descending order.
GET http://IP address:port/prefix/archive/events/detectors/{HOSTNAME}/{ENDTIME}/{BEGINTIME}—get events from detectors from a certain Server.
{HOSTNAME}—Server name (see Get Server list).
GET http://IP address:port/prefix/archive/events/detectors/{VIDEOSOURCEID}/{ENDTIME}/{BEGINTIME}—get events from detectors from a certain camera.
{VIDEOSOURCEID}—three-component source endpoint ID (see Get list of cameras and information about them). For instance, "SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0".
| Parameter | Required | Description |
|---|---|---|
| limit | No | Limit of events from detectors in the response. If not specified, it is equal to 100 |
| offset | No | 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, and so on |
| type | No | Get events from a certain detector. The values of the type parameter are listed in the table below. If you need to get events from several detectors, you need to list them separated by commas |
| join | No | 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_archive | No | 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 an archive) |
| archive | No | The name of the archive from the request to receive the list of archives (see Get archive contents) |
| detector | No | Starting with Axxon One 2.0 Get events from a certain detector. 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=0—get events 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=0—get events from all detectors of Server1. The maximum limit for each detector is 5.
- http://127.0.0.1:80/archive/events/detectors/Server1/past/future?limit=5&offset=0&type=Ray—get events from all sensors of Server1. The maximum limit for each sensor is 5.
- http://127.0.0.1:80/archive/events/detectors/A-ZHUKOV/DeviceIpint.1/SourceEndpoint.video:0:0/future/past?limit=100&detector=hosts/Server1/AVDetector.1/EventSupplier—get events from a certain detector 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 events from several detectors of Server1. The detectors must be listed separated by commas.
- http://127.0.0.1:80/archive/events/detectors/past/future?limit=1&type=Ray—get the current state of all sensors of the Axxon-domain.
Attention!
It is recommended to use the past/future parameter only in the first request. Then you must 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:
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 events starting from the search interval.
When requesting the events of the Queue detector, 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 events 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:
| Detector | type |
|---|---|
| Object tracker or Neural tracker | – |
| Line crossing | oneLine |
| Motion in area | moveInZone |
| Stop in area | stopInZone |
| Entrance in area | comeInZone |
| Exit from area | outOfZone |
| Loitering in area | longInZone |
| Multiple objects | lostObject |
| License plate recognition | plateRecognized |
| License plate recognition (from the list) | listed_lpr_detected |
| Face detector | faceAppeared |
| Face detector (from the list) | listed_face_detected |
| Visitors counter | PeopleIn, PeopleOut |
| Queue detector | QueueDetected |
| Fire detector | FireDetected |
| Smoke detector | SmokeDetected |
| Neural counter | lotsObjects |
| Position change | SceneChangeDetected |
| Image noise detector | CameraBlindDetected |
| Loss of quality | ImageDegradation |
| Blurred image detector | BlurredDegradation |
| Compression artifacts detector | CompressedDegradation |
| Motion detector | MotionDetected |
| Audio loss detector | NullAudio |
| Signal detector | SignalAudio |
| Noise detector | NoiseAudio |
| Human pose detector | – |
| Person down detector | recumbent |
| Sitting person detector | sitDown |
| Hands up detector | handsUp |
| Water level detector | LevelOut |
| Handrail holding detector | handRail |
| People counter | lotsObjects |
| Close-standing people detector | peopleDistance |
| People masking | enabledMaskEvents |
Possible values of the detector parameter:
detector parameter | Detector |
|---|---|
| SceneDescription | Object tracker or Neural tracker |
| CrossOneLine | Line crossing |
| moveInZone | Motion in area |
| StopInZone | Stop in area |
| ComeInZone | Entrance in area |
| OutOfZone | Exit from area |
| LongInZone | Loitering in area |
| lostObject | Multiple objects |
| LprDetector | License plate recognition |
| TvaFaceDetector | Face detector |
| PeopleCounter | Visitors counter |
| QueueDetector | Queue detector |
| FireDetector | Fire detector |
| SmokeDetector | Smoke detector |
| NeuroCounter | Neural counter |
| SceneChange | Position change |
| QualityDegradation | Image noise detector |
| QualityDegradation_v2 | Loss of quality |
| BlurredDegradation | Blurred image detector |
| CompressedDegradation | Compression artifacts detector |
| MotionDetection | Motion detector |
| NullAudioDetection | Audio loss detector |
| SignalAudioDetection | Signal detector |
| NoiseAudioDetection | Noise detector |
| PoseDetector | Human pose detector |
| RecumbentDetector | Person down detector |
| SitDownDetector | Sitting person detector |
| HandsUpDetector | Hands up detector |
| WaterLevelDetector | Water level detector |
| HandRailDetector | Handrail holding detector |
| PeopleCountDetectorBySkeleton | People counter |
| PeopleDistanceDetector | Close-standing people detector |
| PoseMaskingDetector | People masking |
Attention!
- Case sensitivity of event types from detectors is not guaranteed. For instance, ComeInZone, comeInZone and COMEINZOne values are considered as the same ones.
- If you received a value not included in the list, then an embedded detector generated an event.
Overview
Content Tools