Page History

GET http://IPAddress address:port/prefix/archive/events/detectors/{ENDTIME}/{BEGINTIME}—get detections events from detection tools from all Axxon-domain Servers.

Note

title	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 are sorted by time in ascending order.

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

GET http://IP Addressaddress:port/prefix/archive/events/detectors/{HOSTNAME}/{ENDTIME}/{BEGINTIME}—get detections events from detection tools from a certain Server.

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

GET http://IPAddress address:port/prefix/archive/events/detectors/{VIDEOSOURCEID}/{ENDTIME}/{BEGINTIME}—get detections events from detection tools from a certain camera.

Tip
{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".

...

Parameter	Required	Description
limit	No	Limit of detections events from detection tools 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, etc.and so on
type	No	Get detections events from a certain detection tool. The values of the type parameter are listed in the table below. If you need to get detections from events from several detection tools, 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 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 One2.0 Get detections events from a certain detection tool. The values of the detector parameter are listed in the table below

...

http://127.0.0.1:80/archive/events/detectors/Server1/DeviceIpint.2/SourceEndpoint.video:0:0/past/future?limit=10&offset=0—get detections 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 detections events 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=Ray—get detections 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 detections events 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 events 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=Ray—get the current state of all sensors of the Axxon-domain.

Note

title	Attention!

It is recommended to use the past/future parameter only in the first request. Then you should 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.

...

Info

title	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 events starting from the search interval.

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

Code Block

       {
            "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 events from License plate recognition, the response will include an additional plate parameter that will contain the recognized license plate in Unicode format.

...

Possible values of the type parameter:

Detection tool	type
Scene Analytics detection toolsObject Tracker or Neurotracker	–
Line crossingCrossing	oneLine
Motion in areaIn Area	moveInZone
Stop in areaIn Area	stopInZoneAppearance in area
Entrance In Area	comeInZoneDisappearance in area
Exit From Area	outOfZone
Loitering In Area	longInZone
Multiple objectsObjects	lostObject
Number Plate License Plate Recognition	plateRecognized
Number Plate Recognition License Plate Recognition (from the list)	listed_lpr_detected
Face detectionDetection	faceAppeared
Face detection Detection (from the list)	listed_face_detected
Visitors counterCounter	PeopleIn, PeopleOut
Queue detection	QueueDetected
Fire detectionDetection	FireDetected
Smoke detectionDetection	SmokeDetected
Neural countingNeurocounter	lotsObjects
Position change	SceneChangeDetected
Image Noise Detection	CameraBlindDetected
Loss of quality	ImageDegradation
Blurred Image Detection	BlurredDegradation
Compression Artifacts Detection	CompressedDegradation
Motion detection	MotionDetectedNo
signalAudio Loss	NullAudio
Signal Detection	SignalAudio
Noise Detection	NoiseAudio
Pose detectionDetection	–Man down detection
Person Down Detection	recumbent
Sitting person detectionPerson Detection	sitDown
Hands up detection	handsUp
Water level detectionLevel Detection	LevelOut
Handrail holding detection	handRail
People counter	lotsObjects
Close-standing people detection	peopleDistance
People masking	enabledMaskEvents

Possible values of the detector parameter:

Scene Analytics detection tools crossing in area in areaAppearance in areaDisappearance in area objectsNumber Plate detection counter detection detectionNeural countingLoss of qualityImage Noise DetectionNo signal detectionMan down detection person detection detectionShooter level detection

detector	Detection tool
SceneDescription	Object Tracker or Neurotracker
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	Detection
PeopleCounter	Visitors	Counter
QueueDetector	Queue detection
FireDetector	Fire	Detection
SmokeDetector	Smoke	Detection
NeuroCounter	Neurocounter
SceneChange	Position change
QualityDegradation	Image Noise Detection
QualityDegradation_v2	Loss of quality
BlurredDegradation	Blurred Image Detection
CompressedDegradation	Compression Artifacts Detection
MotionDetection	Motion detection
NullAudioDetection	Audio Loss
SignalAudioDetection	Signal Detection
NoiseAudioDetection	Noise Detection
PoseDetector	Pose	Detection
RecumbentDetector	Person Down Detection
SitDownDetector	Sitting	Person Detection
HandsUpDetector	Hands up	ActiveShooterDetector	detection
WaterLevelDetector	Water	Level Detection
HandRailDetector	Handrail holding detection
PeopleCountDetectorBySkeleton	People counter
PeopleDistanceDetector	Close-standing people detection
PoseMaskingDetector	People masking

Note

title	Attention!

Case sensitivity of detection tool triggering types event types from detection tools 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 triggeredgenerated an event.

Page tree

Versions Compared

Old Version 6

New Version 7

Key