Skip to content

Report

Allows the user to enhance Track Reports (reports generated for each process containing information about detected tracks). This can only be done on processes that have already finished. The enhancement adds further details about the detected elements, such as vehicle type, color, or license plate number, if available.

In order to enable this feature on your user, please, contact support@senseaeronautics.com.

To enhance a track report, the user must use the endpoint POST /decorate_tracks/{process_uuid}:

curl -X 'POST' \
  'https://atr.senseaeronautics.com/decorate_tracks/f391286c-836a-4491-bc73-49b7b72d91f7' \
  -H 'accept: application/json' \
  -H 'api_key: api_key' \
  -d ''

If the post is successful (i.e status code 200), you will receive a response with the uuid of the process whose report has been enhanced {"process_uuid": "f391286c-836a-4491-bc73-49b7b72d91f7"}.

If there is an error during the starting of the enhancement process, the API will respond with different status code:

  • 403 - Incorrect api_key, simultaneous active processes limit reached, usage limit etc.
  • 404 - Track report not found in the database
  • 503 - Enhancing service failed

This will trigger the enhancement process, whose status can be checked by the user via GET /decorate_tracks/{process_uuid}/status.

curl -X 'POST' \
  'https://atr.senseaeronautics.com/decorate_tracks/f391286c-836a-4491-bc73-49b7b72d91f7/status' \
  -H 'accept: application/json' \
  -H 'api_key: api_key' \
  -d ''

The user will receive a response such as {"status": "RUNNING"}, where the status may vary between RUNNING, FINISHED or FAILED.

Once the enhancement process is FINISHED, the result can be obtained using GET /process/{process_uuid}/tracks as explained here.