Skip to main content
Skip table of contents

Stream check

Analytics Stream Check.

Returns the current state of the stream.

GET /api/streams/{stream-uid}?format=json
Body
stream-uidoptional
uid

Unique identifier of the stream.

Response
200

Returns a JSON object with information about the stream.

JSON
{
                "uid": "f5fdc046-10b1-11ec-a9fc-addec8dfe22c",
                "status": "WORKING",
                "stream_uid": "ca64108f-bcd1-431e-8e5a-07862d0976f3",
                "stream_case_type": "face-recognition"
            }
uid
uid

Stream identifier.

int
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 file, but notification that it has started working has not yet been received

PREPARED - Stream is ready to start but has not yet been started

WAITING IMAGES - Stream is waiting for image vectorization

DOWN - Stream is inactive due to problems with the video stream

TO REPLACE - Stream is marked for transfer to another server

PAUSE - Stream is marked for pausing

UNPAUSE - Stream is marked to be taken out of pause

IN_PAUSE - Stream is currently paused.

uid
stream_uid

Video stream identifier.

string
stream_case_type

Type of analytics.

JavaScript errors detected

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

If this problem persists, please contact our support.