Report Plugin

Default base URL: http://localhost:8180, prefix: /report

Endpoint List

Method	Path	Description
POST	/report/metrics	Ingest metrics
GET	/report/rooms	List rooms
GET	/report/metrics/{room_id}	Room-level aggregate metrics
GET	/report/metrics/{room_id}/{user_id}	Per-user metrics
GET	/report/history/{room_id}	Room metrics history

Per-endpoint details

1) POST /report/metrics

POST /report/metrics
Content-Type: application/json

{
  "user_id": "u1",
  "room_id": "room-1",
  "sdk_version": "1.2.0",
  "report_time": 1746616000,
  "metrics": [
    {
      "user_id": "u1",
      "streams": [
        {
          "stream_id": "camera",
          "direction": "send",
          "video": { "timestamp": 1746616000, "frame_rate": 25, "width": 1280, "height": 720, "bitrate": 1200 },
          "audio": { "timestamp": 1746616000, "sample_rate": 48000, "channels": 2, "bitrate": 64 },
          "network": { "rtt": 45, "packet_loss": 0.3, "jitter": 8 }
        }
      ]
    }
  ]
}

Field definitions:

Field	Type	Required	Description
user_id	string	Yes	Reporting user ID
room_id	string	Yes	Room ID
sdk_version	string	Yes	SDK version
report_time	int64	Yes	Unix timestamp
metrics	object[]	Yes	User metric entries

2) GET /report/rooms

Returns room IDs that currently have metric data.

3) GET /report/metrics/{room_id}

Param	Type	Required	Description
room_id	string	Yes	Room ID

Returns room aggregate metrics and user metric list.

4) GET /report/metrics/{room_id}/{user_id}

Param	Type	Required	Description
room_id	string	Yes	Room ID
user_id	string	Yes	User ID

Returns latest metrics for one user.

5) GET /report/history/{room_id}

Returns historical snapshots for the room.

Common response example

{
  "code": 0,
  "message": "success",
  "data": null
}

Error Codes

HTTP Status	Scenario
400	Invalid JSON payload
404	Room or user not found