Get Key Metrics API

The Get Key Metrics API provides the ability to fetch the total number of minutes spent on meetings, total number of livetsreams, total number of recordings, total number of token gated meetings and total number of meetings. In order to use the API, you will need to obtain an API key by connecting to your wallet.

Endpoint

GET

https://api.huddle01.com/api/v2/sdk/metrics

GET

metrics

Get Key Metrics API

The API supports a GET request with the following required parameters:

x-api-key - Add your API Key to the headers to fetch all rooms associated with your API Key.

Request

GET • /metrics

const response = await axios.get(
  'https://api.huddle01.com/api/v2/sdk/metrics',
  {},
  {
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': {{API_KEY}},
    },
  }
);

Response

Upon success, the API will return a response with an array of rooms with the following fields:

totalSessions - The total number of sessions for the API Key.
totalDuration - The total number of minutes spent on sessions for the API Key.
totalUsers - The total number of users for the API Key.
recordingCount - The total number of recordings for the API Key.
livestreamCount - The total number of livestreams for the API Key.

In case of an error, the API will return an error message with a corresponding status code.

Response

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

Preview Live Sessions Peers API Get Recordings API