Stats

This endpoint provides access to your meeting stats.

This route needs to be authenticated, see Authentication here

Endpoint

GET https://nodeapi.superviz.com/meetingstats

Query Parameters

Name	Type	Description	Format	Required
month	Number	Filter month	05
year	Number	Filter year	2020
initialDate	String	Filter by initialDate	2022-08-03T08:00:00.000Z
endDate	String	Filter by endDate	2022-08-03T08:00:00.000Z
environment	String	Filter environment	development or production
groupId	String	Filter by groupId
usePagination	Boolean	Return stats paginated	true / false (default false)
onlySummary	Boolean	Return only totals of meetings	true / false (default true)

You can pass the environment parameter to find the whitelisted records based on your SuperViz Token environment, you can pass development or production. The default value is production.

For more precise filter, you need to pass a timestampsZ in initialDate and endDate

eg
    initialDate = "2022-08-03T08:00:00.000Z"
    endDate = "2022-08-03T22:00:00.000Z"

    the final url looks like this:
    https://nodeapi.superviz.com/meetingstats?initialDate="2022-08-03T08:00:00.000Z"&endDate="2022-08-03T22:00:00.000Z"

Responses

200 OK

{
  "totalMeetingMinutes": 2831,
  "totalRecordingMinutes": 1,
  "totalMeetings": 157
}

200 OK (Using onlySummary: false)

[
  {
    "uuid": "e71b7c9f-00d3-435c-ae8f-b70e975fc7b7",
    "id": 107,
    "meetingId": "go7e6m",
    "groupId": "e3d17563-1a4e-4471-bd72-a0a7e8d719bc",
    "groupName": "groupName",
    "userId": "0e1170d5-145d-4607-ab2f-cbd63f0f985e",
    "meetingMinutes": 5,
    "recordingMinutes": 0,
    "price": 5,
    "startedAt": "2022-05-12T21:51:24.915Z",
    "endedAt": "2022-05-12T22:01:25.470Z",
    "createdAt": "2022-05-12T22:01:28.796Z",
    "participants": [
      {
        "uuid": "cd798927-b3c3-46c3-986f-5525e29a9ea9",
        "id": 101,
        "userId": "0e1171d5-165d-4607-ab2f-cbd63f0f985e",
        "permission": "member",
        "name": "user name",
        "createdAt": "2022-05-12T22:01:28.817Z",
        "updatedAt": "2022-05-12T22:01:28.817Z",
        "deletedAt": null
      }
    ]
  }
]

200 OK (Using usePagination: true)

{
  "data": [
    {
      "uuid": "e71b7c9f-00d3-435c-ae8f-b70e975fc7b7",
      "id": 107,
      "meetingId": "go7e6m",
      "groupId": "e3d17563-1a4e-4471-bd72-a0a7e8d719bc",
      "groupName": "groupName",
      "userId": "0e1170d5-145d-4607-ab2f-cbd63f0f985e",
      "meetingMinutes": 5,
      "recordingMinutes": 0,
      "price": 5,
      "startedAt": "2022-05-12T21:51:24.915Z",
      "endedAt": "2022-05-12T22:01:25.470Z",
      "createdAt": "2022-05-12T22:01:28.796Z",
      "participants": [
        {
          "uuid": "cd798927-b3c3-46c3-986f-5525e29a9ea9",
          "id": 101,
          "userId": "0e1171d5-165d-4607-ab2f-cbd63f0f985e",
          "permission": "member",
          "name": "user name",
          "createdAt": "2022-05-12T22:01:28.817Z",
          "updatedAt": "2022-05-12T22:01:28.817Z",
          "deletedAt": null
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "totalPages": 41,
    "limit": 10,
    "total": 404
  }
}

401 Unauthorized

{
  "statusCode": 401,
  "message": "Unauthorized"
}

401 Unauthorized (Authenticated is not developer)

{
  "statusCode": 401,
  "message": "You need to be a developer to access meeting stats.",
  "error": "Unauthorized"
}