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

detections

events from detectors in the response. If

not

it isn't specified,

it

the deafult value is

equal to

100

.


offset	No	The offset of the results

offset

by the specified number.

For

For example, if a query with offset=0

returned

returns 100 results, then

in order

to get the next results,

it is necessary to

you must run a query

with

with offset=100. If the second query

returned

returns 250 results, then

in order

to get the next results,

it is necessary to

you must run a query

with

with offset=350,

etc.

and so on
type	No	Get

detections

events from a detector of a certain

detection tool. The parameter values

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

the two-phase events

will be

are merged together, and the duration parameter

will be

is returned

which

that corresponds to the event duration.
If join=0, then in the response, the two-phase events

will not be merged together.

aren't merged together
limit_to_archive	No

If

If limit_to_archive=1, then the response

will return

returns the events only from the accessible part of the archive (see

Configuring access restrictions to

older footage

an archive)

.


archive	No	The name of the archive from the request to

receive

get the list of archives (

see

see Get archive contents)

.

Sample requests:

...

detector

No

Get events from a specific detector of a specific camera. To get a specific value, you can run a query, 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

...

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

...

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

...

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

Sample response:

Expand

title	Click to expand

1) join=1

Code Block

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

Code Block

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{
     "bottom": "0.72451157569885249",
     "index": "0",
      "timestampleft": "20190618T1251420.417000092941055297851571",
     "right": "0.24284084320068361",
      "typetop": "moveInZone0.4965816402435303"
    }
    }],
        {
            "alertState"source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "20190618T112814.426000",
   "type": "beganmoveInZone",
  },
  {
   "duration": "000005.155000",
    "id": "310ce582dc953fad-5f0dbb08-4c274bae-a1d5bdce-b14ccc5a877d62a09ab2dbd9",
            "multiPhaseSyncIdorigin": "6d72973d-7188-4fa7-9bf9-e3ba6013f2e3hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [
     {
     "originbottom": "hosts/Server1/AppDataDetector.1/EventSupplier0.37916545867919921",
     "index": "0",
      "rectanglesleft": ["0.10621988296508789",
     "right": "0.2311831474304199",
     "top": "0.11115360260009766"
    {}
   ],
        "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
         "bottom"timestamp": "020190618T112814.46943313598632813293000",
   "type": "moveInZone"
  },
  {
   "duration": "000003.170000",
   "id": "f00875f0-bad7-4e74-879c-0a564baa9d36",
    "indexorigin": "0hosts/Server1/AppDataDetector.1/EventSupplier",
          "rectangles": [
    {
      "leftbottom": "0.146422286033630362848846626281738",
     "index": "0",
        "left": "0.11811468601226806",
      "right": "0.2302564096450805418662774562835693",
                    "top": "0.02776645660400389711245393753051756"
                }
            ],
            "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp": "20190618T12514220190618T112813.200000358000",
            "type": "moveInZone"
  }
 ],
     },
        {
            "more": true
}

2) join=0

Code Block

{
 "events": [
  {
   "alertState": "beganended",
            "id": "aa193bbccd3571bb-89e873c1-420445cb-88058965-ac8c915b323ca01e167836db",
            "multiPhaseSyncId": "807248bf6d72973d-4cee7188-431e4fa7-a29f9bf9-18ee0ed911cee3ba6013f2e3",
            "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
            "rectangles": [
                {
      ,
   "rectangles": [],
       "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "bottomtimestamp": "020190618T125142.36835212707519532417000",
   "type": "moveInZone"
  },
  {
   "alertState": "began",
      "id": "310ce582-5f0d-4c27-a1d5-b14ccc5a877d",
   "indexmultiPhaseSyncId": "06d72973d-7188-4fa7-9bf9-e3ba6013f2e3",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [
    {
        "leftbottom": "0.07250120162963866246943313598632813",
                    "rightindex": "0.19335731506347656",
                    "topleft": "0.0321290969848632714642228603363036",
     "right": "0.23025640964508054",
     "top": "0.027766456604003897"
    }
            ],
            "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp": "20190618T12514120190618T125142.966000200000",
            "type": "moveInZone"
        },
  {
      {"alertState": "began",
   "id": "aa193bbc-89e8-4204-8805-ac8c915b323c",
   "multiPhaseSyncId": "807248bf-4cee-431e-a29f-18ee0ed911ce",
    "alertStateorigin": "endedhosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [
    {
     "idbottom": "5b15234d-2a7f-415f-af57-2ac1ce5aa75a0.36835212707519532",
            "multiPhaseSyncIdindex": "17fca913-f7a3-4f29-997f-d02a575d9fc40",
     "left": "0.072501201629638662",
      "originright": "hosts/Server1/AppDataDetector.1/EventSupplier0.19335731506347656",
            "rectangles"top": [],"0.03212909698486327"
    }
   ],
     "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp": "20190618T12513620190618T125141.978000",
        966000",
    "type": "moveInZone"
        },
        {
            "alertState": "ended",
            "id": "48882f925b15234d-a8092a7f-424c415f-b7a7af57-55ac56b050612ac1ce5aa75a",
            "multiPhaseSyncId": "8bb9edbe17fca913-4391f7a3-4c264f29-8c7a997f-7faf620a62ebd02a575d9fc4",
            "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
            "rectangles": [],
            "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp": "20190618T125136.661000978000",
            "type": "moveInZone"
        },
        {
            "alertState": "ended",
            "id": "6e98f97948882f92-c4f4a809-4c78424c-bbf4b7a7-6fc268219d7955ac56b05061",
            "multiPhaseSyncId": "92534e2f8bb9edbe-0f884391-46984c26-a1a28c7a-4e70d10cb00a7faf620a62eb",
            "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
            "rectangles": [],
            "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp": "20190618T125136.477000661000",
            "type": "moveInZone"
        },
        {
        
  },
  {
    "alertState": "ended",
            "id": "c9dff8bc6e98f979-423bc4f4-414b4c78-8deebbf4-0a0b119a43df6fc268219d79",
            "multiPhaseSyncId": "c878515192534e2f-f3440f88-4c214698-88dea1a2-6c339139afdf4e70d10cb00a",
            "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
            "rectangles": [],
            "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp": "20190618T12513520190618T125136.843000477000",
            "type": "moveInZone"
        },
        {
            "alertState": "ended",
            "id": "db1f1147c9dff8bc-ed50423b-46ff414b-84b78dee-8f06676d8f8e0a0b119a43df",
            "multiPhaseSyncId": "7eceb0b4c8785151-c04df344-4e174c21-a40588de-3aff419fd94a",
         6c339139afdf",
   "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
            "rectangles": [],
            "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp": "20190618T125135.677000843000",
            "type": "moveInZone"
        },
        {
            "alertState": "beganended",
            "id": "f9cccedadb1f1147-9e16ed50-483246ff-9f1f84b7-1270fd0be3658f06676d8f8e",
            "multiPhaseSyncId": "17fca9137eceb0b4-f7a3c04d-4f294e17-997fa405-d02a575d9fc43aff419fd94a",
            "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
            "rectangles": [],
                {
                    "bottom"source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
   "timestamp": "020190618T125135.30296741485595702677000",
   "type": "moveInZone"
  },
  {
        "alertState": "began",
    "indexid": "0f9ccceda-9e16-4832-9f1f-1270fd0be365",
                    "left"multiPhaseSyncId": "17fca913-f7a3-4f29-997f-d02a575d9fc4",
   "origin": "0.14849423646926879hosts/Server1/AppDataDetector.1/EventSupplier",
   "rectangles": [
           {
     "rightbottom": "0.2126261401176452530296741485595702",
              "index": "0",
      "topleft": "0.092105445861816404"
                }14849423646926879",
     "right": "0.21262614011764525",
      ],"top": "0.092105445861816404"
    }
   ],
     "source": "hosts/Server1/DeviceIpint.1/SourceEndpoint.video:0:0",
            "timestamp": "20190618T125135.677000",
            "type": "moveInZone"
        },
        {
            "alertState": "began",
       ": "began",
     "id": "87ca4e1e-4a8c-433a-8b67-6e73f65fa0e2",
            "multiPhaseSyncId": "7eceb0b4-c04d-4e17-a405-3aff419fd94a",
            "origin": "hosts/Server1/AppDataDetector.1/EventSupplier",
            "rectangles": [
                {
                    "bottom": "0.22597263336181642",
               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
}    }
    ],
    "more": true
}

Note

title	Attention!

By default, the request timeout is 10 seconds.

If the Server server fails to return all events 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, it is necessary to you must repeat the request and reduce the value of the limit parameter.

Info

title	Note

The multiPhaseSyncId parameter

will be

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

Field timestamp is not unique so it might be necessary to

The timestamp field isn't unique, so you must skip the previously received

alarms

events from detectors starting from the search interval.

When requesting you request the events of the queue detection tool triggeringsdetector, the response includes 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"
    },
    {
     "alertStatequeueMin": "happened4",
    }
   ],
     "extraid": ["b17129b2-1588-794b-94f6-d078a226efb2",
   "origin": "hosts/Server1/AVDetector.4/EventSupplier",
   "rectangles": [],
        {"source": "hosts/Server1/DeviceIpint.2/SourceEndpoint.video:0:0",
   "timestamp": "20181206T075621.621000",
                "queueMax"type": "4QueueDetected"
                },
                {
                    "queueMin": "4"
                }
            ],
            "id": "b17129b2-1588-794b-94f6-d078a226efb2",
            "origin": "hosts/Server1/AVDetector.4/EventSupplier",
            "rectangles": [],
            "source"}
}

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,
					"right" : 0.67222222222222228,
					"top" : 0.64409722222222221
				}
			],
			"source" : "hosts/Server1/DeviceIpint.21/SourceEndpoint.video:0:0",
            			"timestamp" : "20181206T07562120230725T140945.621000208000",
            "type": "QueueDetected"
        }
}

Available values of type parameter:

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

Detection tooltypeScene Analytics detection tools-


Line crossing	oneLine
Motion

in area	moveInZone
Stop in area	stopInZone

Appearance in

Entrance in area

comeInZone

Disappearance

Exit from area	outOfZone
Loitering in area	longInZone
Multiple objects	lostObject

Number Plate Recognition

License plate recognition

plateRecognized

Number Plate Recognition

License plate recognition (from the list)	listed_lpr_detected
Face

detection

detector	faceAppeared
Face

detection

detector (from the list)	listed_face_detected
Visitors counter	PeopleIn, PeopleOut
Queue

detection

detector	QueueDetected
Fire

detection

detector	FireDetected
Smoke

detection

detector	SmokeDetected
Neural

counting

counter	lotsObjects
Position change	SceneChangeDetected
Image

Noise Detection

noise detector	CameraBlindDetected
Loss of quality	ImageDegradation
Blurred

Image Detection

image detector	BlurredDegradation
Compression

Artifacts Detection

artifacts detector	CompressedDegradation
Motion

detection

detector

MotionDetected

No signal

Audio loss detector	NullAudio
Signal detector	SignalAudio
Noise detector	NoiseAudio

Pose detection-Man down detection

Human pose detector	–
Person down detector	recumbent
Sitting person

detection

detector	sitDown
Hands up

detection

detector	handsUp
Shooter detector	activeShooter
Water level

detection

detector	LevelOut
Handrail holding

detection

detector	handRail
People counter	lotsObjects
Close-standing people

detection

detector	peopleDistance
People masking	enabledMaskEvents

Info

title	Note

If the non-included in the list value is received, then an embedded detection tool triggered.

Note

title	ImportantAttention!

Case sensitivity of

detector triggering types is not

event types from detectors isn't guaranteed. For

instance

example,

'

ComeInZone

'

,

'

comeInZone

'

and

'

COMEINZOne

'

values are

to be

considered as the same

ones

values.
If you received a value that isn't included in the list, then this is an event from an embedded detector.

Page tree

Versions Compared

Old Version 1

New Version Current

Key

General information

Examples of requests

Examples of a response

Possible values of the type parameter