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://nodeapi.superviz.com/meetings \
--header 'apiKey: {API_KEY}' \
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:
Name | Description |
---|---|
apikey | Required. You must utilize the Developer Token that can be found on the developer page. By utilizing this key, we will define whether to get data from the developer or the production environment. |
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:
Name | Type | Description |
---|---|---|
meetingId | string | The ID of the meeting. |
roomId | string | The ID of the room where the meeting took place. |
group | object | The group information. |
group.id | string | The ID of the group. |
group.name | string | The name of the group. |
startedAt | string | The time that the meeting started. |
endedAt | string | The time that the meeting ended. |
meetingMinutes | number | The total minutes of the meeting. |
recordingMinutes | number | The total minutes of the recording. |
price | number | The total price of the meeting, consisting of the sum of the minutes of all participants plus the recording minutes. |
participants | array | The list of participants that attended the meeting. |
participants[].id | string | The ID of the participant. |
participants[].name | string | The name of the participant. |
participants[].minutes | number | The 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
}
]
},
]