Room

To see the statistics for a concrete room -> execute a GET request against /rooms/:id/statistics

To see the statistics only for the current billing period -> execute a GET request against /rooms/:id/statistics/current endpoint instead.

You can choose a custom period with the date_start and date_end query params.

api/v1/rooms/:id/statistics?date_start=2023-01-01&date_end=2024-03-28

By default all metrics are returned. If you are interested only in concrete metrics you can filter them out with the metrics query param. Separate with a comma if multiple metrics. api/v1/rooms/:id/statistics?metrics=participation_minutes,max_concurrent_participants

Request

cURL

curl --request GET \
  --url https://api.digitalsamba.com/api/v1/rooms/87a5d383-9e79-44ea-b382-686e430f4ecc/statistics \
  --user YOUR_TEAM_ID:YOUR_DEVELOPER_KEY

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.util.Base64;
import java.util.Map;

String TEAM_ID = "YOUR_TEAM_ID";
String DEVELOPER_KEY = "YOUR_DEVELOPER_KEY";
String authorizationHeader = "Bearer " + Base64.getEncoder().encodeToString((TEAM_ID + ":" + DEVELOPER_KEY).getBytes());
//Put your room id or friendly_url (name) here - this value is just an example
String roomId = "c39d7c40-7ff7-4faa-b06f-698a639a9523";

HttpRequest request = HttpRequest.newBuilder()
  .GET()
  .uri(new URI("https://api.digitalsamba.com/api/v1/rooms/" + roomId + "/statistics"))
  .header("Authorization", authorizationHeader)
  .build();

HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(request, BodyHandlers.ofString());

System.out.println("Status code: " + response.statusCode());
System.out.println("Body: " + response.body());

Response (200 OK)

{
    "room_id": "8707051e-22e1-4140-adce-334a3a4be3e0",
    "room_external_id": null,
    "room_description": null,
    "room_friendly_url": "EasySpanish",
    "room_privacy": "public",
    "room_source": "dashboard",
    "room_max_participants": 100,
    "room_is_deleted": false,
    "participation_minutes": 73,
    "desktop_participation_minutes": 73,
    "mobile_participation_minutes": 0,
    "tablet_participation_minutes": 0,
    "smarttv_participation_minutes": 0,
    "broadcasted_minutes": 43,
    "subscribed_minutes": 62,
    "screen_broadcasted_minutes": 0,
    "screen_subscribed_minutes": 0,
    "live_participants": 0,
    "active_participants": 2,
    "desktop_participants": 2,
    "mobile_participants": 0,
    "tablet_participants": 0,
    "smarttv_participants": 0,
    "sessions": 1,
    "max_concurrent_participants": 4,
    "e2ee_minutes": 0,
    "recorded_minutes": 0,
    "stored_recorded_minutes": 0,
    "whiteboard_minutes": 0,
    "active_roles": 2,
    "breakout_minutes": 0,
    "presentation_minutes": 0,
    "public_chat_posts": 0,
    "questions": 0,
    "answers": 0,
    "date_start": "2024-03-17",
    "date_end": "2024-04-16"
}