Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 older footagearchive)

archiveNo

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

detectorNo

Starting with Axxon One2.0

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://root:root@127127.0.0.1:80/archive/events/detectors/Server1A-ZHUKOV/DeviceIpint.1/SourceEndpoint.video:0:0/20230323T112000.000/20230430T210000.000future/past?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 commasdetector=hosts/Server1/AVDetector.1/EventSupplier—get detections from a certain detection tool of Server1.
  • http://127root:root@127.0.0.1:80/archive/events/detectors/past/future/Server1/DeviceIpint.1/SourceEndpoint.video:0:0/20230323T112000.000/20230430T210000.000?limit=1100&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 Rayget the current state of all sensors of the Axxon-domain.

...

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"
        }
}

Available values of the type parameter:

        "type": "QueueDetected"
        }
}

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
SceneDescription
Detection tooltype
Scene Analytics detection tools
-
CrossOneLineLine crossing
oneLine
moveInZoneMotion in area
moveInZone
StopInZoneStop in area
stopInZone
ComeInZoneAppearance in area
comeInZone
OutOfZoneDisappearance in area
outOfZone
LongInZoneLoitering
longInZone
lostObjectMultiple objects
lostObject
LprDetectorNumber Plate Recognition
plateRecognizedNumber Plate Recognition (from the list)listed_lpr_detectedFace detectionfaceAppearedFace detection (from the list)
TvaFaceDetectorFace detection
PeopleCounter
listed_face_detected
Visitors counter
PeopleIn, PeopleOut
QueueDetectorQueue detection
QueueDetected
FireDetectorFire detection
FireDetected
SmokeDetectorSmoke detection
SmokeDetected
NeuroCounterNeural counting
lotsObjects
SceneChangePosition change
SceneChangeDetectedLoss of qualityImageDegradation
QualityDegradationLoss of quality
QualityDegradation_v2

Image Noise Detection

CameraBlindDetected
BlurredDegradation
Blurred Image Detection
BlurredDegradation
CompressedDegradationCompression Artifacts Detection
CompressedDegradation
MotionDetectionMotion detection
MotionDetected
NullAudioDetectionNo signal
NullAudio
SignalAudioDetectionSignal
SignalAudio
NoiseAudioDetection

Noise

NoiseAudio
PoseDetectorPose detection
-
RecumbentDetectorMan down detection
recumbent
SitDownDetectorSitting person detection
sitDown
HandsUpDetectorHands up detection
handsUp
ActiveShooterDetectorShooter detection
WaterLevelDetectorWater level detection
LevelOut
HandRailDetectorHandrail holding detection
handRail
PeopleCountDetectorBySkeletonPeople counter
lotsObjects
PeopleDistanceDetectorClose-standing people detection
peopleDistance
PoseMaskingDetectorPeople masking
enabledMaskEvents

...

titleNote


Note
titleAttention!
  • 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.