Skip to main content

Get meetings stats

This endpoint enables you to get a list of meetings that have taken place. The response will include the meeting ID, room ID, group information, start and end times, total meeting minutes, total recording minutes, total price, and a list of participants who attended the meeting.

How to use

You can use the following cURL to obtain a response from this endpoint:

curl --request GET \
--url https://api.superviz.com/meetings \
--header 'client_id: {CLIENT_ID}' \
--header 'secret: {SECRET}' \

HTTP Request

GET /meetings

In the request, you will need to send in the path following field:

TO-BE-DEFINED

Headers

When using this endpoint, you need to provide the API Key. The following headers are required:

NameDescription
client_idRequired. You need to use the Client ID to authenticate in this repository. You can retrieve your Client ID under the Dashboard > Developer > Keys.
secretRequired. You need to use the Secret Key to authenticate in this repository. You can create a new API Secret under our Dashboard > Developer > Keys.

Response

Status code 200 will indicate that the request was successful. The response will be a list of recordings in JSON format with our pagination schema and include the following fields:

NameTypeDescription
meetingIdstringThe ID of the meeting.
roomIdstringThe ID of the room where the meeting took place.
groupobjectThe group information.
group.idstringThe ID of the group.
group.namestringThe name of the group.
startedAtstringThe time that the meeting started.
endedAtstringThe time that the meeting ended.
meetingMinutesnumberThe total minutes of the meeting.
recordingMinutesnumberThe total minutes of the recording.
pricenumberThe total price of the meeting, consisting of the sum of the minutes of all participants plus the recording minutes.
participantsarrayThe list of participants that attended the meeting.
participants[].idstringThe ID of the participant.
participants[].namestringThe name of the participant.
participants[].minutesnumberThe total minutes of the participant in the meeting.

Example:

[
{
"meetingId": "6cd81af7-7a57-4df0-a879-b336b0642206",
"roomId": "demos",
"group": {
"id": "Olimpus",
"name": "daily"
},
"startedAt": "2024-02-23T15:30:39.195Z",
"endedAt": "2024-02-23T15:53:40.304Z",
"meetingMinutes": 51,
"recordingMinutes": 0,
"price": 51,
"participants": [
{
"id": "1510",
"name": "Zeus",
"minutes": 17
},
{
"id": "407",
"name": "Hera",
"minutes": 17
}
]
},
]