Stream Area Frame
GET
{{mbembo_ws_url}}/ws/v1/mbembo/area/{{areaID}}
Mbembo/AreaFrameWebsocket
This is Websocket. You can't test through this page
Try to test this feature via the websocket client.
Payload has all clients belonging to the Area.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET '{{dev_mbembo_ws_url}}/ws/v1/mbembo/area/1?interval=1000&at='Response Response Example
{
"trID": "20250212123629155755",
"eventVersion": 1,
"eventType": "NewFrame",
"actionType": "Create",
"actor": {
"uid": "00000000-0000-0000-0000-000000000000",
"userName": ""
},
"payload": {
"areaID": 1,
"createdAt": "2025-02-12T12:36:28.956858Z",
"clientFrames": [
{
"id": 0,
"clientID": 1,
"mode": 17,
"frameSeq": 967,
"createdAt": "2025-02-12T12:36:29.141365Z",
"areaID": 1,
"areaSeqNum": 0,
"activeLidar": 1,
"client": {
"id": 1,
"createdAt": "2025-02-11T09:59:06.394Z",
"updatedAt": "2025-02-12T12:36:22.462Z",
"deletedAt": 0,
"areaID": 1,
"name": "local",
"host": "localhost",
"port": 10221,
"fingerprint": "5ab42ecb8ca187d26ac9d63d9b2654e8a347d14706c661098990621833351e3f",
"lidarCount": 0,
"frameRate": 100,
"clientMode": 17,
"alarmType": "None",
"clientStat": {
"id": 39,
"createdAt": "2025-02-12 12:36:20",
"clientID": 1,
"zoneID": 1,
"congestionLevel": 1,
"zoneCount": 2,
"passingCount": 0,
"activeLidarCount": 1
},
"area": {
"id": 1,
"createdAt": "2025-02-11T09:58:53.544Z",
"updatedAt": "2025-02-11T09:58:53.544Z",
"deletedAt": 0,
"name": "local",
"description": "local",
"clients": []
},
"zones": [
{
"id": 1,
"clientID": 1,
"name": "liveZone",
"areaM2": 3288.967,
"vertices": [
{
"x": -32.02945,
"y": 32.490665,
"z": 0
},
{
"x": 28.211512,
"y": 32.490665,
"z": 0
},
{
"x": 28.211512,
"y": -22.106188,
"z": 0
},
{
"x": -32.02945,
"y": -22.106188,
"z": 0
}
],
"targetClass": [
"CAR",
"TRUCK",
"PEDESTRIAN",
"CYCLIST"
],
"filterClass": [],
"violationClass": [],
"targetSides": [
{
"index": 0,
"name": "1",
"violationDirection": "In"
}
],
"congestionMode": "Simple",
"congestionLevels": [
{
"level": 1,
"threshold": 1,
"rgb": "#349af9"
},
{
"level": 2,
"threshold": 11,
"rgb": "#e6d806"
}
],
"roles": "None"
},
{
"id": 2,
"clientID": 1,
"name": "test123",
"areaM2": 9622.088,
"vertices": [
{
"x": -69.52634,
"y": -25.850113,
"z": 0
},
{
"x": 57.71725,
"y": -25.850113,
"z": 0
},
{
"x": 57.71725,
"y": -101.46954,
"z": 0
},
{
"x": -69.52634,
"y": -101.46954,
"z": 0
}
],
"targetClass": [],
"filterClass": [],
"violationClass": [],
"targetSides": [],
"congestionMode": "Simple",
"congestionLevels": [],
"roles": "None"
}
]
},
"zoneFrames": [
{
"id": 0,
"zoneID": 1,
"zoneName": "liveZone",
"clientFrameID": 1958,
"avgVelocity": 10.153513,
"avgTime": "141ns",
"vobjectCount": 2,
"areaMSquare": 3288.967,
"congestionValue": 2,
"congestionLevel": 1,
"zone": null,
"vobjects": []
},
{
"id": 0,
"zoneID": 2,
"zoneName": "test123",
"clientFrameID": 1958,
"avgVelocity": 0,
"avgTime": "0s",
"vobjectCount": 0,
"areaMSquare": 9622.088,
"congestionValue": 0,
"congestionLevel": 0,
"zone": null,
"vobjects": []
}
],
"vObjects": [
{
"id": "2502121236286411778",
"clientID": 1,
"clientFrameID": 967,
"createdAt": "0001-01-01T00:00:00Z",
"type": "PEDESTRIAN",
"age": 50,
"zoneID": 1,
"beforeZoneID": 0,
"zoneFlag": 0,
"inTime": "0001-01-01T00:00:00Z",
"stayDuration": "0s",
"outTime": "0001-01-01T00:00:00Z",
"inTargetSide": 0,
"outTargetSide": 0,
"latitude": 0,
"longitude": 0,
"position": {
"x": -4.8,
"y": 0.2999997,
"z": 0.9
},
"width": 0.8,
"length": 0.5,
"height": 1.8,
"angle": 225,
"velocityX": 11,
"velocityY": 4,
"trajectories": [
{
"x": 9.2,
"y": 8.2,
"z": 0
},
{
"x": 6.3999996,
"y": 7.2999997,
"z": 0
},
{
"x": 3.5999997,
"y": 5.7999997,
"z": 0
},
{
"x": 0.7999997,
"y": 3.5999997,
"z": 0
},
{
"x": -2.0000002,
"y": 3.0999997,
"z": 0
},
{
"x": -4.8,
"y": 0.2999997,
"z": 0
}
],
"target": true,
"filtered": false,
"violationType": 0,
"warningType": 0
},
{
"id": "2502121236276400306",
"clientID": 1,
"clientFrameID": 967,
"createdAt": "0001-01-01T00:00:00Z",
"type": "CAR",
"age": 118,
"zoneID": 0,
"beforeZoneID": 1,
"zoneFlag": 0,
"inTime": "0001-01-01T00:00:00Z",
"stayDuration": "0s",
"outTime": "0001-01-01T00:00:00Z",
"inTargetSide": 0,
"outTargetSide": 0,
"latitude": 0,
"longitude": 0,
"position": {
"x": -51.79999,
"y": 46.8,
"z": 0.8
},
"width": 2.5,
"length": 4.2,
"height": 1.6,
"angle": 143.13011,
"velocityX": 12,
"velocityY": 7,
"trajectories": [
{
"x": -9.8,
"y": 23.8,
"z": 0
},
{
"x": -12.6,
"y": 25,
"z": 0
},
{
"x": -15.400001,
"y": 26.9,
"z": 0
},
{
"x": -18.2,
"y": 29.6,
"z": 0
},
{
"x": -21,
"y": 30.4,
"z": 0
},
{
"x": -23.8,
"y": 31.8,
"z": 0
},
{
"x": -26.599998,
"y": 33.899998,
"z": 0
},
{
"x": -29.399998,
"y": 35.1,
"z": 0
},
{
"x": -32.199997,
"y": 36.899998,
"z": 0
},
{
"x": -34.999996,
"y": 39.399998,
"z": 0
},
{
"x": -37.799995,
"y": 42.1,
"z": 0
},
{
"x": -40.599995,
"y": 42.8,
"z": 0
},
{
"x": -43.399994,
"y": 43,
"z": 0
},
{
"x": -46.199993,
"y": 43.7,
"z": 0
},
{
"x": -48.999992,
"y": 44.7,
"z": 0
},
{
"x": -51.79999,
"y": 46.8,
"z": 0
}
],
"target": false,
"filtered": false,
"violationType": 0,
"warningType": 0
},
{
"id": "2502121236290466857",
"clientID": 1,
"clientFrameID": 967,
"createdAt": "0001-01-01T00:00:00Z",
"type": "PEDESTRIAN",
"age": 91,
"zoneID": 1,
"beforeZoneID": 0,
"zoneFlag": 0,
"inTime": "0001-01-01T00:00:00Z",
"stayDuration": "0s",
"outTime": "0001-01-01T00:00:00Z",
"inTargetSide": 0,
"outTargetSide": 0,
"latitude": 0,
"longitude": 0,
"position": {
"x": 15.6,
"y": 26.1,
"z": 0.9
},
"width": 0.8,
"length": 0.5,
"height": 1.8,
"angle": 318.23972,
"velocityX": 7,
"velocityY": 5,
"trajectories": [
{
"x": 12.8,
"y": 28.6,
"z": 0
},
{
"x": 15.6,
"y": 26.1,
"z": 0
}
],
"target": true,
"filtered": false,
"violationType": 0,
"warningType": 0
}
]
}
]
}
}Request
Query Params
interval
numberÂ
optional
Example:
1000
at
stringÂ
optional
Example:
{{token}}
Responses
Modified at 2025-02-12 08:55:26