Telemetría

Conoce nuestra API de telemetría y estadísticas.

Obtén el análisis de calidad WebRTC de una sala (sesión) bajo demanda: un reporte determinístico con puntajes y recomendaciones, un snapshot en vivo, o el resumen persistido de la sesión.

Autorización

Todos los endpoints descritos a continuación utilizan la cabecera Authorization con esquema Bearer.

Un API token lo puedes obtener desde nuestro dashboard. Este deberá ser de tipo api-token, el cual es el único permitido para VPaaS.

Si estás en ambiente de desarrollo, te recomendamos crear un token sin lista blanca de IPs; esto evitará problemas de bloqueos por IP dinámica.

---

Vistas disponibles (view)

report (default)	Análisis completo de la sesión: puntaje de calidad, métricas clave, patrones detectados y recomendaciones accionables.	Cacheado
snapshot	Rollup calculado en tiempo real desde la telemetría cruda. Útil mientras la sesión sigue activa ("qué ha pasado hasta ahora").	No persiste
summary	Rollup persistido de la sesión (por peer y por minuto). Disponible una vez que la sesión fue compilada.	Persistido

---

Get session stats

get

Retrieve on-demand WebRTC quality analytics for a room (session). Use the view query parameter to choose the analysis type, and the Accept header to choose the response format (text/markdown is only supported for view=report).

Autorizaciones

BearerAuth

AuthorizationstringRequerido

Bearer token authentication using API token

Parámetros de ruta

roomIdstringRequerido

Room ID (ObjectId) or external ID

Example: 64f1a2b3c4d5e6f7a8b9c0d1

Parámetros de consulta

viewstring · enumOpcional

Analysis type to return.

Default: reportExample: reportValores posibles:

refreshbooleanOpcional

For view=report only. Force regeneration instead of returning the cached report.

Default: falseExample: false

Parámetros de encabezado

Acceptstring · enumOpcional

Response format. text/markdown is only supported for view=report.

Default: application/jsonExample: application/jsonValores posibles:

Respuestas

200

Successful response. Body shape depends on the view parameter.

application/jsontext/markdown

Respuestaone of

o

o

400

Bad request - invalid view

application/json

401

Unauthorized - Invalid or missing API token

application/json

403

Forbidden - the token is not an api-token, or IP not allowed

application/json

404

Not found - room not found, or no telemetry available for this session

application/json

500

Internal server error

application/json

get/vpaas/rooms/{roomId}/stats

HTTPcURLJavaScriptPython

GET /vpaas/rooms/{roomId}/stats HTTP/1.1
Host: api.videsk.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "schemaVersion": 1,
  "generatedAt": "2024-08-14T18:05:00.000Z",
  "sessionId": "64f1a2b3c4d5e6f7a8b9c0d1",
  "overview": {
    "sessionStart": "2026-07-09T14:23:47.432Z",
    "sessionEnd": "2026-07-09T14:23:47.432Z",
    "durationMinutes": 12.5,
    "totalPeers": 2,
    "totalRecords": 740
  },
  "summary": {
    "status": "SUCCESSFUL",
    "score": 92.5,
    "scoreBreakdown": {
      "connectionStability": 1,
      "packetLoss": 1,
      "latency": 1,
      "videoQuality": 1
    },
    "keyMetrics": {
      "audioLossPct": 1,
      "videoLossPct": 1,
      "avgRttMs": 1,
      "maxRttMs": 1,
      "rttQuality": "excellent",
      "realDisconnections": 1,
      "reconnections": 1,
      "connectionTypeChanges": 1,
      "avgUptimePct": 1
    }
  },
  "peers": [
    {
      "peerId": "text",
      "alias": "text",
      "type": "text",
      "userAgent": "text",
      "connectionType": "text",
      "protocol": "text",
      "networkType": "text",
      "country": "text",
      "region": "text",
      "city": "text",
      "firstSeen": "2026-07-09T14:23:47.432Z",
      "lastSeen": "2026-07-09T14:23:47.432Z",
      "durationSeconds": 1,
      "audioLossPct": 1,
      "videoLossPct": 1,
      "videoFreezes": 1,
      "videoFreezeDuration": 1
    }
  ],
  "rtt": [
    {
      "peerId": "text",
      "samples": 1,
      "avgRttMs": 1,
      "minRttMs": 1,
      "maxRttMs": 1,
      "stddevRttMs": 1,
      "spikeCount": 1
    }
  ],
  "packetLoss": [
    {
      "peerId": "text",
      "audioLossPct": 1,
      "videoLossPct": 1
    }
  ],
  "videoIssues": [
    {
      "peerId": "text",
      "videoFreezes": 1,
      "videoFreezeDuration": 1,
      "framesDroppedPct": 1
    }
  ],
  "jitter": [
    {
      "peerId": "text",
      "avgAudioJitterMs": 1,
      "maxAudioJitterMs": 1,
      "avgVideoJitterMs": 1,
      "maxVideoJitterMs": 1
    }
  ],
  "disconnections": [
    {
      "peerId": "text",
      "disconnectionTime": "2026-07-09T14:23:47.432Z",
      "reconnectionTime": "2026-07-09T14:23:47.432Z",
      "offlineDurationSeconds": 1
    }
  ],
  "stability": [
    {
      "peerId": "text",
      "sessionDurationMinutes": 1,
      "disconnectionCount": 1,
      "totalOfflineMinutes": 1,
      "uptimePercentage": 1
    }
  ],
  "userAgents": [
    {
      "browser": "text",
      "browserVersion": "text",
      "os": "text",
      "isMobile": true,
      "peerCount": 1,
      "percentage": 1
    }
  ],
  "patterns": [
    {
      "id": "text",
      "title": "text",
      "verdict": "text",
      "severity": "INFORMATIONAL",
      "explanation": "text"
    }
  ],
  "recommendations": {
    "status": "SUCCESSFUL",
    "items": [
      {
        "audience": "immediate",
        "priority": "critical",
        "title": "text",
        "detail": "text"
      }
    ]
  }
}