Get Metrics

getMetrics() provides the ability to fetch the total number of minutes spent on meetings, total number of livestream, total number of recordings, total number of token gated meetings and total number of meetings. You need an API_KEY to use this function.

Example

import { API } from '@huddle01/server-sdk/api';
 
const metrics = async () => {
  const api = new API({
    apiKey: process.env.API_KEY!,
  });
 
  const metrics = await api.getMetrics();
 
  return metrics;
};

Returns

getMetrics() will return an array of rooms with following fields

{
 "totalSessions": 156,
 "totalDuration": 10254,
 "totalUsers": 849,
 "recordingCount": 7,
 "livestreamCount": 2
}