Versions Compared

Old Version 4

changes.mady.by.user Alena Kniazeva

Saved on

compared with

New Version 5

changes.mady.by.user Alena Kniazeva

Saved on

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 footage).

archiveNo

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

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 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=0—get 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=Ray—get detections from all sensors of Server1. The maximum limit for each sensor is 5.
  • 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 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.

...