Get transcripts stats

This endpoint enables you to retrieve stats information for every transcription.

Before we start

This endpoint will bring data for the meeting where transcription was activated during the meeting. This can be achieved by either clicking the toolbar at the bottom of the interface or by invoking the toggleTranscript() method on the Video Conference.

How to use

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

curl --location --request GET https://nodeapi.superviz.com/transcript/stats \
	--header  "Authorization: Bearer ${TOKEN}" \

HTTP Request

GET https://nodeapi.superviz.com/transcript/stats

Headers

When using this endpoint, you need to provide the Authorization Bearer token.

Queries

In the query of this request, you can use the following fields:

Name	Description
environment	This field allows you to filter the environment of the transcription meetings. You can choose between development or production.

Response Body

Successful request

Status code 200 will indicate that the request was successful. The response will be in JSON format and include a list of objects that contains the following fields:

Name	Type	Description
uuid	string	A unique identifier for the transcription record.
meetingId	string	The identifier of the meeting associated with the transcription.
minutes	number	The duration of the transcription in minutes.
startedAt	Date	The timestamp indicating when the transcription started, using the format: YYYY-MM-DDTHH:MM:SS.sssZ.
finishedAt	Date	The timestamp indicating when the transcription was completed, using the format: YYYY-MM-DDTHH:MM:SS.sssZ.
groupId	string	The identifier of the group related to the transcription.
groupName	string	The name of the group associated with the transcription.
createdAt	Date	The timestamp indicating when the transcription record was created, using the format: YYYY-MM-DDTHH:MM:SS.sssZ.
updatedAt	Date	The timestamp indicating when the transcription record was last updated, using the format: YYYY-MM-DDTHH:MM:SS.sssZ.

Example:

[
  {
    "uuid": "8e2ff45e-d795-48ff-96f5-84e248ed2722",
    "meetingId": "<MEETING_ID>",
    "minutes": 2,
    "startedAt": "2023-11-06T21:53:18.055Z",
    "finishedAt": "2023-11-06T21:55:30.320Z",
    "groupId": "<GROUP_ID>",
    "groupName": "<GROUP_NAM>",
    "createdAt": "2023-11-06T21:55:35.510Z",
    "updatedAt": "2023-11-06T21:55:35.510Z"
  }
]

Invalid request

When the API encounters an invalid request, it will provide a response with the following information:

Name	Type	Description
statusCode	number	The HTTP Status Code.
error	string	The HTTP Status name provides information on the error type.
message	string	An explanation of the error and actionable steps to resolve it.

Example:

{
	"statusCode": 403,
	"error": "Forbidden",
	"message": "You have reached the limit of topic requests",
}