Page History

Section

Column

width	50%

Panel

borderColor	#CCCCCC
bgColor	#FFFFFF
titleBGColor	#F0F0F0
borderStyle	solid
title	On the page:

Table of Contents

Column

General information

...

GET

http://IP address:port/prefix/archive/events/detectors/{ENDTIME}/{BEGINTIME}—get events from detectors from all

...

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 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.
Tip
{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.
Tip
{VIDEOSOURCEID}—three-component source endpoint ID (see Get list of cameras and information about them). For example, "SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0".

Parameter	Required	Description
limit	No	Limit of events from detectors in the response. If it

is not

isn't specified, the deafult value is 100
offset	No	The offset of the results by the specified number. For example, if a query with offset=0 returns 100 results, then

in order

to get the next results, you must run a query

with

with offset=100. If the second query returns 250 results, then

in order

to get the next results, you must run a query

with

with offset=350, and so on
type	No	Get events from a detector of a

ceratin

certain type. Possible values of the type parameter are listed in the table below. If you need to get events from several types of detectors, you must list them separated by commas
join	No	If join=1, then in the response, the two-phase events are merged together, and the duration parameter is returned that corresponds to the event duration. If join=0, then in the response, the two-phase events aren't merged together
limit_to_archive	No	If limit_to_archive=1, then the response returns 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 get the list of archives (see Get archive contents)
detector	No

Starting with Axxon One 2.0

Get events from a specific detector of a specific camera. To get a specific value, you can run a query

(see

, see Get a list of detectors

)

of a camera.

After you run a query, the value for the detector parameter is specified in the name parameter, for example:

"name" : "hosts/SERVER/AVDetector.1/EventSupplier"

Note

title	Attention!

Specify {VIDEOSOURCEID} in the request address for the correct operation of the detector, archive and limit_to_archive parameters.

Examples of 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
number 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
number 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
number for each sensor is 5.
http://127.0.0.1:80/archive/events/detectors/Server1/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.
Note
title Attention!
We recommend using the past/future parameter only in the first request. After that you must get the timestamp of the most recent recording and use it to request subsequent recordings. Using the past/future parameter along with the limit and offset parameters in subsequent requests can result in duplicate recordings.

Examples of a response

...

Expand

title	Click to expand

1) join=1

Code Block

{
    "events": [
        {
            "duration": "000000.467000",
            "id": "09b8729a"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"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""rectangles": [
                {
                    "bottom": "0.72451157569885249",
                    "index": "0",
                    "left": "0.092941055297851571",
                    "right": "0"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",
                   "bottom"left": "0.3791654586791992110621988296508789",
                    "indexright": "0.2311831474304199",
                    "left"top": "0.1062198829650878911115360260009766",
    }
   ],
     "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
        "righttimestamp": "020190618T112814.2311831474304199293000",
   "type": "moveInZone"
  },
  {
      "duration": "000003.170000",
      "topid": "0.11115360260009766"f00875f0-bad7-4e74-879c-0a564baa9d36",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [
    {
    }  "bottom": "0.2848846626281738",
     "index": "0",
      ]"left": "0.11811468601226806",
     "right": "0.18662774562835693",
      "sourcetop": "hosts/0.11245393753051756"
    }
   ],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp": "20190618T11281420190618T112813.293000358000",
            "type": "moveInZone"
        }}
 ],
        {
            "duration": "000003.170000",
            "more": true
}

2) join=0

Code Block

{
 "events": [
  {
   "alertState": "ended",
   "id": "f00875f0cd3571bb-bad773c1-4e7445cb-879c8965-0a564baa9d36a01e167836db",
       "multiPhaseSyncId": "6d72973d-7188-4fa7-9bf9-e3ba6013f2e3",
     "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
     "rectangles": [],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "rectanglestimestamp": ["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.284884662628173846943313598632813",
     "index": "0",
       "left": "0.14642228603363036",
       "indexright": "0.23025640964508054",
       "top": "0.027766456604003897"
    }
   ],
      "leftsource": "0.11811468601226806hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T125142.200000",
   "type": "moveInZone"
  },
  {
        "rightalertState": "0.18662774562835693began",
   "id": "aa193bbc-89e8-4204-8805-ac8c915b323c",
   "multiPhaseSyncId": "807248bf-4cee-431e-a29f-18ee0ed911ce",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [
    {
     "topbottom": "0.1124539375305175636835212707519532",
     "index": "0",
          }"left": "0.072501201629638662",
     "right": "0.19335731506347656",
      ],"top": "0.03212909698486327"
    }
    ],
    "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp": "20190618T11281320190618T125141.358000966000",
            "type": "moveInZone"
  },
  {
    }
    ],
    "more": true
}

2) join=0

Code Block

{
 "events": [
  {
   "alertState""alertState": "ended",
   "id": "cd3571bb5b15234d-73c12a7f-45cb415f-8965af57-a01e167836db2ac1ce5aa75a",
   "multiPhaseSyncId": "6d72973d17fca913-7188f7a3-4fa74f29-9bf9997f-e3ba6013f2e3d02a575d9fc4",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T12514220190618T125136.417000978000",
   "type": "moveInZone"
  },
  {
   "alertState": "beganended",
   "id": "310ce58248882f92-5f0da809-4c27424c-a1d5b7a7-b14ccc5a877d55ac56b05061",
   "multiPhaseSyncId": "6d72973d8bb9edbe-71884391-4fa74c26-9bf98c7a-e3ba6013f2e37faf620a62eb",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [],
    {"source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
     "bottomtimestamp": "020190618T125136.46943313598632813661000",
     "indextype": "0moveInZone"
  },
  {
   "leftalertState": "0.14642228603363036ended",
     "rightid": "0.230256409645080546e98f979-c4f4-4c78-bbf4-6fc268219d79",
     "topmultiPhaseSyncId": "0.027766456604003897"92534e2f-0f88-4698-a1a2-4e70d10cb00a",
    }"origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T12514220190618T125136.200000477000",
   "type": "moveInZone"
  },
  {
   "alertState": "beganended",
   "id": "aa193bbcc9dff8bc-89e8423b-4204414b-88058dee-ac8c915b323c0a0b119a43df",
   "multiPhaseSyncId": "807248bfc8785151-4ceef344-431e4c21-a29f88de-18ee0ed911ce6c339139afdf",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [],
    {
     "bottom"source": "0.36835212707519532hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
     "indextimestamp": "020190618T125135.843000",
     "lefttype": "0.072501201629638662"moveInZone"
  },
  {
   "rightalertState": "0.19335731506347656ended",
     "topid": "0.03212909698486327"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": "20190618T12514120190618T125135.966000677000",
   "type": "moveInZone"
  },
  {
   "alertState": "endedbegan",
   "id": "5b15234df9ccceda-2a7f9e16-415f4832-af579f1f-2ac1ce5aa75a1270fd0be365",
   "multiPhaseSyncId": "17fca913-f7a3-4f29-997f-d02a575d9fc4",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
 {
     "timestampbottom": "20190618T1251360.97800030296741485595702",
     "typeindex": "moveInZone0"
  },
  {
   "alertStateleft": "ended0.14849423646926879",
     "idright": "48882f92-a809-424c-b7a7-55ac56b050610.21262614011764525",
     "multiPhaseSyncIdtop": "8bb9edbe-4391-4c26-8c7a-7faf620a62eb",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": ["0.092105445861816404"
    }
   ],
   "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T12513620190618T125135.661000677000",
   "type": "moveInZone"
  },
  {
   "alertState": "endedbegan",
   "id": "6e98f97987ca4e1e-c4f44a8c-4c78433a-bbf48b67-6fc268219d796e73f65fa0e2",
   "multiPhaseSyncId": "92534e2f7eceb0b4-0f88c04d-46984e17-a1a2a405-4e70d10cb00a3aff419fd94a",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [],

    {
     "sourcebottom": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:00.22597263336181642",
     "timestampindex": "20190618T125136.4770000",
     "typeleft": "moveInZone"
  }0.080717468261718744",
  {
   "alertStateright": "ended0.19577339172363281",
     "idtop": "c9dff8bc-423b-414b-8dee-0a0b119a43df"0.014194698333740235"
    }
   ],
   "multiPhaseSyncIdsource": "c8785151-f344-4c21-88de-6c339139afdf",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [],
   "source": "hosts/hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T12513520190618T125134.843000909000",
   "type": "moveInZone"
  },
  {],
   "alertStatemore": "ended",true
}     "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
}

Note

title	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:

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

In this case, you must repeat the request and reduce the value of the limit parameter.

Info

title	Note

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

The timestamp field is not unique, so it can be necessary to skip the previously received events from detectors starting from the search interval.

When you request the events of the Queue detector, the response will include an additional extra parameter that contains 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 you request the events from License plate recognition detectors, the response will include an additional plate parameter that contains the recognized license plate in Unicode format.

Note

title	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:

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

In this case, you must repeat the request and reduce the value of the limit parameter.

Info

title	Note

The multiPhaseSyncId parameter is in the response only for two-phase alarms with the alertState parameter.
The timestamp field isn't unique, so you must skip the previously received events from detectors starting from the search interval.

When you request the events of the queue detector, the response will include an additional extra parameter that contains 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 you request the events from License plate recognition detectors, the response will include an additional plate parameter that contains the recognized license plate in Unicode format.

Code Block

{
			"alertState" : "happened",
			"id" : "f1f334a3-3fb3-4770-80bf-c6519240b5cf",
			"origin" : "hosts/Server1/AVDetector.1/EventSupplier",
			"plate" : "\u0412427\u0412\u041c99",
			"rectangles" : 
			[
				{
					"bottom" : 0.70833333333333337,
					"index" : 0,
					"left" : 0.4597222222222222,

Code Block

  "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

...

Note

title	Attention!

Possible values of the type parameter depend on the product version and installed detectors. To get the current values, you can run a query to get the list of detectors of a specific camera (see Get a list of detectors of a camera).

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
Shooter detector	activeShooter
Water level detector	LevelOut
Handrail holding detector	handRail
People counter	lotsObjects
Close-standing people detector	peopleDistance
People masking	enabledMaskEvents

Note

title	Attention!

Case sensitivity of event types from detectors isn't guaranteed. For example, ComeInZone, comeInZone and COMEINZOne values are considered as the same values.
If you received a value that

is not

isn't included in the list, then this is an event from an embedded detector.

Page tree

Versions Compared

Old Version 15

New Version Current

Key

General information

Examples of requests

Examples of a response

Possible values of the type parameter