Skip to main content
Skip table of contents

List of streams

Returns a list of streams.

GET /client_api/streams/
Body
searchrequired
string

Search by unique stream identifier, unique stream UID, unique executable UID, server name.

orderingrequired
string

Sorting by analytics stream status.

binary_uidrequired
string

Filtering by unique executable UID.

statusrequired
string

Filtering by stream status.

Response
200

Returns a JSON array of objects with stream information.

JSON
[{
            "id": 1,
            "job_uid": "80257b9f-327d-11ec-8f46-dc41a97a0ad6",
            "binary_id": 2,
            "binary_type": "motion-detect",
            "status": "CREATED",
            "stream_uid": "80257b9f-327d-11ec-8f46-dc41a97a0ad6",
            "camera_group_uid": "77757b9f-327d-55ec-8f46-dc41a97a0ad3"
        }]
int
id
uid
job_uid

Unique stream identifier.

int
binary_id

Executable UID.

string
binary_type

Type of analytics.

face-recognition - face recognition
motion-detect - motion detection
visitors-counting - visitor counting
licplate-recognition - license plate recognition
person-counting - people counting in the area
camera-obstacle - camera damage/obstruction/vandalism detection
loud-sounds - loud sound detection
line-intersection - line crossing detection
smoke-fire - smoke/fire detection

string
status

Current state of the stream.

WORKING - Stream is running normally
CREATED - Stream has been created
UPDATED - Stream has been updated
PENDING - Stream has been sent to the executable, but notification that it has started working has not yet been received
PREPARED - Stream is ready to run, but has not started yet
WAITING IMAGES - Stream is waiting for image vectorization
DOWN - Stream is not active due to video stream problems
TO REPLACE - Stream is marked for transfer to another server
PAUSE - Stream is marked to be put in pause mode
UNPAUSE - Stream is marked to be taken out of pause mode
IN_PAUSE - Stream is in pause mode

uid
stream_uid

Unique video stream identifier.

uid
camera_group_uid

Unique camera group identifier, which combines several streams into one group.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.