openapi: 3.0.0 info: description: | # Authentication Meetric supports JWT tokens. You should pass `Authorization: JWT {token}` for each secured request. version: '0.1.0' title: 'Meetric API docs' servers: - url: 'https://api.meetric.com/api' description: 'Production environment' components: securitySchemes: jwt: type: http scheme: bearer bearerFormat: JWT description: > JWT token. Should be supplied in `Authorization` header. Example: `Authorization: JWT {token}` security: - jwt: [] paths: /login: post: summary: Login operationId: login tags: - User requestBody: content: application/json: schema: type: object required: - userName - password properties: userName: type: string description: Email for user example: user@gmail.com password: type: string example: querty123 session_id: type: string example: 4a53d3e5-20ad-4c4d-a518-f13a42626e39 description: If passed, Response will be empty. responses: 200: description: Successful request content: application/json: schema: type: object properties: JWT: type: string 401: description: Access denied /login/google: get: summary: Login with Google account operationId: googleLogin tags: - User parameters: - name: session_id in: query required: false example: 4a53d3e5-20ad-4c4d-a518-f13a42626e39 description: The field is optional. If passed, Response for route /api/login/google/check will be empty. - name: redirect_uri in: query required: false example: https://example.com/redirect responses: 301: description: Redirects to Google login modal /login/google/check: get: summary: Finish login with Google operationId: googleLoginFinish tags: - User parameters: - name: code in: query required: true description: Code from Google responses: 200: description: Successful request content: application/json: schema: type: object properties: JWT: type: string 401: description: Access denied /login_as/{user}: post: security: - jwt: [] summary: Login as user operationId: loginAs description: Only for user with `ROLE_SUPER_ADMIN` role tags: - User responses: 200: description: Successful request content: application/json: schema: type: object properties: JWT: type: string 401: description: Access denied 404: description: User is not found /login_sessions/{sessionId}: get: summary: Get token by sessionId operationId: loginSessions tags: - User responses: 200: description: Successful request content: application/json: schema: type: object properties: JWT: type: string 401: description: Access denied 404: description: Token is not found /me: get: security: - jwt: [] tags: - Security summary: Get current user operationId: me responses: 200: description: Successful request content: application/json: schema: allOf: - $ref: '#/definitions/User' - type: object properties: google_drive: type: boolean accounts: type: array items: properties: domain: type: string example: test status: type: string nullable: true description: Only for admin notes: type: string nullable: true description: Only for admin sales_contact: type: string nullable: true description: Only for admin price_per_user: type: string nullable: true description: Only for admin amount_of_users: type: string nullable: true description: Only for admin contract_interval: type: string nullable: true description: Only for admin contract_start: type: string nullable: true description: Only for admin is_beta: type: boolean example: "false" /reset-password: post: tags: - Security summary: Send email to reset password operationId: resetPassword requestBody: content: application/json: schema: type: object required: - email properties: email: type: string example: john@gmail.com responses: 200: description: Successful request content: application/json: {} 404: description: Email is not found /reset-password/{token}: post: summary: Reset password with token from email operationId: resetPasswordCheck tags: - Security requestBody: content: application/json: schema: type: object required: - password properties: password: type: string example: querty123 responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/User' 400: $ref: '#/definitions/BadRequest' 404: description: Token is already user or invalid /register: post: summary: Register User operationId: registerUser tags: - User requestBody: content: application/json: schema: type: object required: - company_name - first_name - last_name - email - password properties: company_name: type: string example: Comany first_name: type: string example: John last_name: type: string example: Smith email: type: string example: john@gmail.com password: type: string example: querty123 responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/User' 400: $ref: '#/definitions/BadRequest' 409: description: Email is already registered /register/{token}: post: summary: Register User with token from email operationId: registerUserWithToken tags: - User requestBody: content: application/json: schema: type: object required: - password properties: password: type: string example: querty123 responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/User' 400: $ref: '#/definitions/BadRequest' 404: description: Token is already user or invalid /users: get: security: - jwt: [] summary: Get Users operationId: getUsers description: Only for user with `ROLE_SUPER_ADMIN` role tags: - User responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/User' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /users/{userId}: put: security: - jwt: [] summary: Edit User operationId: editUser tags: - User requestBody: content: application/json: schema: $ref: '#/requestBodies/User' responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/User' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden 404: description: User not found /users/{userId}/accounts: get: security: - jwt: [] summary: Get accounts by user operationId: getAccountsByUser tags: - Account responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/AccountFull' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden 404: description: User not found /change-password: post: security: - jwt: [] tags: - Security summary: Change password for the current user operationId: changePassword requestBody: content: application/json: schema: type: object properties: current_password: type: string example: current new_password: type: string example: new responses: 200: description: Successful request content: application/json: schema: type: object properties: success: type: boolean example: true 400: description: Current password is invalid /teams: post: security: - jwt: [] summary: Create a team operationId: createTeam tags: - Team requestBody: content: application/json: schema: $ref: '#/requestBodies/Team' responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/Team' 400: description: Prerequisite failed 401: description: Access denied 404: description: Account not found 403: description: Access forbidden /teams/{teamId}/user/{userId}: post: security: - jwt: [] summary: Add user to team operationId: addToTeam tags: - Team responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/Team' 401: description: Access denied 403: description: Access forbidden 404: description: Team or User are not found 409: description: User is not in the account or user is already in the team delete: security: - jwt: [] summary: Remove user from team operationId: removeFromTeam tags: - Team responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/Team' 401: description: Access denied 403: description: Access forbidden 404: description: Team or User are not found 409: description: User is not in the team /users/{userId}/managed_teams: get: security: - jwt: [] summary: Get managed teams operationId: getManagedTeams tags: - Team responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/Team' 401: description: Access denied 403: description: Access forbidden 404: description: Team or User is not found /teams/{teamId}/manager/{userId}: post: security: - jwt: [] summary: Add manager to team operationId: addManagerToTeam tags: - Team responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/Team' 401: description: Access denied 403: description: Access forbidden 404: description: Team or User are not found 409: description: User is not in the account or user is already team manager delete: security: - jwt: [] summary: Remove user from team managers operationId: removeFromTeamManagers tags: - Team responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/Team' 401: description: Access denied 403: description: Access forbidden 404: description: Team or User are not found 409: description: User is not manager of the team /teams/{teamId}: put: security: - jwt: [] summary: Update a team operationId: updateTeam tags: - Team requestBody: content: application/json: schema: $ref: '#/requestBodies/Team' responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/Team' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden 404: description: Team not found /accounts: post: security: - jwt: [] summary: Create account operationId: createAccount tags: - Account requestBody: content: application/json: schema: $ref: '#/requestBodies/Account' responses: 200: description: Successful request content: application/json: schema: type: object $ref: '#/definitions/AccountFull' 400: $ref: '#/definitions/BadRequest' 401: description: Access denied 403: description: Access forbidden /accounts/{accountId}: put: security: - jwt: - admin summary: Update account operationId: Update tags: - Account requestBody: content: application/json: schema: allOf: - $ref: '#/requestBodies/Account' - type: object properties: status: type: string nullable: true description: Only for superadmin notes: type: string nullable: true description: Only for superadmin sales_contact: type: string nullable: true description: Only for superadmin price_per_user: type: string nullable: true description: Only for superadmin amount_of_users: type: string nullable: true description: Only for superadmin contract_interval: type: string nullable: true description: Only for superadmin contract_start: type: string nullable: true description: Only for superadmin responses: 200: description: Successful request content: application/json: schema: type: object $ref: '#/definitions/AccountFull' 400: $ref: '#/definitions/BadRequest' 401: description: Access denied 404: description: Account not found 403: description: Access forbidden /accounts/{accountId}/brand: post: security: - jwt: [ ] operationId: uploadAccountBrand summary: Upload accound logo and backgound deprecated: true tags: - Account requestBody: content: multipart/from-data: schema: type: object properties: logo: type: file description: Max image size is 10 mb background: type: file description: Max image size is 10 mb responses: 200: description: Successful request content: application/json: schema: type: object $ref: '#/definitions/AccountFull' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden 404: description: Account not found /accounts/{accountId}/rights: get: security: - jwt: [] summary: Get rights by account operationId: getRightsByAccount tags: - Right parameters: - name: right_type in: query type: string enum: - presentation - file - name: object_id in: query description: presentation or file id type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/Right' 401: description: Access denied 404: description: Account not found 403: description: Access forbidden /accounts/{accountId}/teams: get: security: - jwt: [] summary: Get teams by account operationId: getTeamsByAccount tags: - Team responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/Team' 401: description: Access denied 404: description: Account not found 403: description: Access forbidden /accounts/{accountId}/users: get: security: - jwt: [] summary: Get users by account operationId: getUsersByAccount tags: - User responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/User' 401: description: Access denied 403: description: Access forbidden 404: description: Account not found put: security: - jwt: [] summary: Add users to account operationId: addUsersToAccount tags: - Account requestBody: content: application/json: schema: required: - users_ids type: object properties: users_ids: type: array items: type: integer example: 1 responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/Account' 400: $ref: '#/definitions/BadRequest' 401: description: Access denied 403: description: Access forbidden 404: description: Account not found delete: security: - jwt: [] summary: Delete users from account operationId: deleteUsersFromAccount tags: - Account requestBody: content: application/json: schema: required: - users_ids type: object properties: users_ids: type: array items: type: integer example: 1 responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/Account' 400: $ref: '#/definitions/BadRequest' 401: description: Access denied 403: description: Access forbidden 404: description: Account not found post: security: - jwt: [] summary: Create User operationId: createUser tags: - User requestBody: content: application/json: schema: type: object required: - email - first_name - last_name properties: email: type: string example: yolo@yolo.com first_name: type: string example: Joe last_name: type: string example: Doe mobile_number: type: string example: 01231232132131 responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/User' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{accountId}/users/{userId}/role: put: security: - jwt: [] summary: Edit user role for account operationId: editUserRole tags: - Account requestBody: content: application/json: schema: type: object required: - role properties: role: $ref: '#/definitions/AccountRight' responses: 200: description: Successful request content: application/json: schema: allOf: - $ref: '#/definitions/User' - type: object properties: right_level: $ref: '#/definitions/AccountRight' 401: description: Access denied 403: description: Access forbidden 404: description: Account or User not found /accounts/{accountId}/categories: get: security: - jwt: [] summary: Get categories by account operationId: getCategoriesByAccount tags: - Account responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/Category' 401: description: Access denied 403: description: Access forbidden 404: description: Account not found /rights: post: security: - jwt: [] summary: Create a right operationId: createRight tags: - Right requestBody: content: application/json: schema: $ref: '#/requestBodies/Right' responses: 200: description: Successful request content: application/json: schema: type: object $ref: '#/definitions/Right' 401: description: Access denied 404: description: Entity not found 403: description: Access forbidden /rights/{rightId}: put: security: - jwt: [] summary: Update a right operationId: updateRight tags: - Right requestBody: content: application/json: schema: $ref: '#/requestBodies/Right' responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/Right' 401: description: Access denied 403: description: Access forbidden 404: description: Entity not found delete: security: - jwt: [] summary: Delete a right operationId: deleteRight parameters: - name: right_type in: query required: true schema: type: string enum: - presentation - file - room - folder tags: - Right responses: 204: description: Successful request 401: description: Access denied 403: description: Access forbidden 404: description: Entity not found /invitations/{account}: post: security: - jwt: [] summary: Invite user to an account operationId: inviteUser tags: - Account requestBody: content: application/json: schema: type: object properties: user_id: type: integer example: 1 responses: 200: description: Successful request content: application/json: schema: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 400: description: Prerequisite failed 401: description: Access denied 404: description: Account not found 403: description: Access forbidden /invitations/{accountInvitation}/accept: get: security: - jwt: [] summary: Accept invite operationId: acceptInvite tags: - Account responses: 200: description: Successful request content: application/json: schema: type: object example: [] 400: description: Prerequisite failed 401: description: Access denied 404: description: Account not found 403: description: Access forbidden /analytics: post: security: - jwt: [] summary: Add an analytics event operationId: addAnalyticsEvent description: 'Alias: `POST /api/data`' tags: - Analytics requestBody: content: application/json: schema: $ref: '#/requestBodies/Analytics' responses: 200: description: Successful request content: application/json: schema: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 400: $ref: '#/definitions/BadRequest' /accounts/{account}/receivers/{receiverId}: get: summary: Get a receiver operationId: receiver tags: - Receivers responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/SingleReceiver' /receivers: get: summary: Get list of receivers operationId: receiverList tags: - Receivers responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/Receiver' parameters: - name: presentation_id in: query description: Filter by presentation ID type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: session_id in: query description: Filter by session ID type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 post: summary: Add a receiver to account operationId: addReceiverToAccount tags: - Receivers requestBody: content: application/json: schema: $ref: '#/requestBodies/DocumentReceiverWithAccount' responses: 200: description: Successful request content: application/json: schema: type: object $ref: '#/definitions/Receiver' 400: $ref: '#/definitions/BadRequest' /receivers/multi: post: summary: Add many receivers operationId: addReceiverMulti tags: - Receivers requestBody: content: application/json: schema: type: object required: - account_id - receivers properties: account_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 receivers: type: array items: $ref: '#/requestBodies/DocumentReceiver' responses: 200: description: Successful request content: application/json: schema: type: object $ref: '#/definitions/Receiver' 400: $ref: '#/definitions/BadRequest' /shared_presentation/{sharableToken}/session: post: security: - jwt: [] summary: Create a session operationId: createSession tags: - Session requestBody: content: application/json: schema: type: object properties: id: type: string description: If not provided will be generated example: d8d891da-9843-4fb6-b22f-852aa692a862 responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/User' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/team: get: security: - jwt: [] summary: Team statistics operationId: teamStats tags: - Analytics parameters: - name: global_start in: query description: Start date of analytics data schema: type: date example: "2022-01-01" - name: global_end in: query description: End date of analytics data schema: type: date example: "2022-01-31" - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: page_id in: query schema: type: string example: 1 - name: numeric_filters in: query responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/TeamStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/team_daily: get: security: - jwt: [] summary: Team daily statistics operationId: teamDailyStats tags: - Analytics parameters: - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: interval in: query schema: type: string enum: - daily - weekly - monthly - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: page_id in: query schema: type: string example: 1 responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/TeamDailyStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{accountId}/stats/user: get: security: - jwt: [] summary: User statistics operationId: userStats tags: - Analytics parameters: - name: global_start in: query description: Start date of analytics data schema: type: date example: "2022-01-01" - name: global_end in: query description: End date of analytics data schema: type: date example: "2022-01-31" - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: user_id in: query schema: type: number example: 1 - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: page_id in: query schema: type: string example: 1 - name: numeric_filters in: query responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/UserStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{accountId}/stats/user_daily: get: security: - jwt: [] summary: User daily statistics operationId: userDailyStats tags: - Analytics parameters: - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: interval in: query schema: type: string enum: - daily - weekly - monthly - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: user_id in: query schema: type: number example: 1 - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: page_id in: query schema: type: string example: 1 responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/UserDailyStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/meetings: get: security: - jwt: [] summary: Meetings statistics operationId: meetingsStats tags: - Analytics parameters: - name: global_start in: query description: Start date of analytics data schema: type: date example: "2022-01-01" - name: global_end in: query description: End date of analytics data schema: type: date example: "2022-01-31" - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: user_id in: query schema: type: number example: 1 - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: session_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: page_id in: query schema: type: string example: 1 - name: contact_id in: query schema: type: string example: 1143a56d-cd48-4b15-b021-341eda120241 - name: company_id in: query schema: type: string example: 06745090-506c-4e9a-8c48-286e40b590ed - name: numeric_filters in: query responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/MeetingsStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/meetings_daily: get: security: - jwt: [] summary: Meetings daily statistics operationId: meetingsDailyStats tags: - Analytics parameters: - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: interval in: query schema: type: string enum: - daily - weekly - monthly - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: user_id in: query schema: type: number example: 1 - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: session_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: page_id in: query schema: type: string example: 1 - name: contact_id in: query schema: type: string example: 1143a56d-cd48-4b15-b021-341eda120241 - name: company_id in: query schema: type: string example: 06745090-506c-4e9a-8c48-286e40b590ed responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/MeetingsDailyStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/meetings_live: get: security: - jwt: [] summary: Meetings Live statistics operationId: meetingsLiveStats tags: - Analytics parameters: - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: user_id in: query schema: type: number example: 1 - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/MeetingsLiveStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/sessions/{sessionId}/meeting-ai-analytics: get: security: - jwt: [] summary: Meeting AI Analytics operationId: meetingAIAnalytics tags: - Analytics responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/MeetingAIAnalytics' 403: description: Access forbidden /accounts/{account}/stats/rooms: get: security: - jwt: [] summary: Rooms statistics operationId: roomsStats tags: - Analytics parameters: - name: global_start in: query description: Start date of analytics data schema: type: date example: "2022-01-01" - name: global_end in: query description: End date of analytics data schema: type: date example: "2022-01-31" - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: user_id in: query schema: type: number example: 1 - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: page_id in: query schema: type: string example: 1 - name: contact_id in: query schema: type: string example: 1143a56d-cd48-4b15-b021-341eda120241 - name: company_id in: query schema: type: string example: 06745090-506c-4e9a-8c48-286e40b590ed - name: numeric_filters in: query responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/RoomsStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/rooms_daily: get: security: - jwt: [] summary: Rooms daily statistics operationId: roomsDailyStats tags: - Analytics parameters: - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: interval in: query schema: type: string enum: - daily - weekly - monthly - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: user_id in: query schema: type: number example: 1 - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: page_id in: query schema: type: string example: 1 - name: contact_id in: query schema: type: string example: 1143a56d-cd48-4b15-b021-341eda120241 - name: company_id in: query schema: type: string example: 06745090-506c-4e9a-8c48-286e40b590ed responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/RoomsDailyStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/room_sessions: get: security: - jwt: [] summary: Room Sessions statistics operationId: roomSessionsStats tags: - Analytics parameters: - name: global_start in: query description: Start date of analytics data schema: type: date example: "2022-01-01" - name: global_end in: query description: End date of analytics data schema: type: date example: "2022-01-31" - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: contact_id in: query schema: type: string example: 1143a56d-cd48-4b15-b021-341eda120241 - name: company_id in: query schema: type: string example: 06745090-506c-4e9a-8c48-286e40b590ed - name: numeric_filters in: query responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/RoomSessionsStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/room_sessions_daily: get: security: - jwt: [] summary: Room Sessions daily statistics operationId: roomSessionsDailyStats tags: - Analytics parameters: - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: interval in: query schema: type: string enum: - daily - weekly - monthly - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: contact_id in: query schema: type: string example: 1143a56d-cd48-4b15-b021-341eda120241 - name: company_id in: query schema: type: string example: 06745090-506c-4e9a-8c48-286e40b590ed responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/RoomSessionsDailyStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/participants: get: security: - jwt: [] summary: Participants statistics operationId: participantsStats tags: - Analytics parameters: - name: global_start in: query description: Start date of analytics data schema: type: date example: "2022-01-01" - name: global_end in: query description: End date of analytics data schema: type: date example: "2022-01-31" - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: session_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: numeric_filters in: query responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/ParticipantsStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/participants_daily: get: security: - jwt: [] summary: Participants daily statistics operationId: participantsDailyStats tags: - Analytics parameters: - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: interval in: query schema: type: string enum: - daily - weekly - monthly - name: session_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/ParticipantsDailyStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/members: get: security: - jwt: [] summary: Members statistics operationId: membersStats tags: - Analytics parameters: - name: global_start in: query description: Start date of analytics data schema: type: date example: "2022-01-01" - name: global_end in: query description: End date of analytics data schema: type: date example: "2022-01-31" - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: numeric_filters in: query responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/MembersStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/members_daily: get: security: - jwt: [] summary: Members daily statistics operationId: membersDailyStats tags: - Analytics parameters: - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: interval in: query schema: type: string enum: - daily - weekly - monthly - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/MembersDailyStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/contacts: get: security: - jwt: [] summary: Contacts statistics operationId: contactsStats tags: - Analytics parameters: - name: global_start in: query description: Start date of analytics data schema: type: date example: "2022-01-01" - name: global_end in: query description: End date of analytics data schema: type: date example: "2022-01-31" - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: user_id in: query schema: type: number example: 1 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: page_id in: query schema: type: string example: 1 - name: contact_id in: query schema: type: string example: 1143a56d-cd48-4b15-b021-341eda120241 - name: numeric_filters in: query responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/ContactsStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/contacts_daily: get: security: - jwt: [] summary: Contacts daily statistics operationId: contactsDailyStats tags: - Analytics parameters: - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: interval in: query schema: type: string enum: - daily - weekly - monthly - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: user_id in: query schema: type: number example: 1 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: page_id in: query schema: type: string example: 1 - name: contact_id in: query schema: type: string example: 1143a56d-cd48-4b15-b021-341eda120241 responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/ContactsDailyStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/companies: get: security: - jwt: [] summary: Companies statistics operationId: companiesStats tags: - Analytics parameters: - name: global_start in: query description: Start date of analytics data schema: type: date example: "2022-01-01" - name: global_end in: query description: End date of analytics data schema: type: date example: "2022-01-31" - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: company_id in: query schema: type: string example: 06745090-506c-4e9a-8c48-286e40b590ed - name: numeric_filters in: query responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/CompaniesStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/companies_daily: get: security: - jwt: [] summary: Companies daily statistics operationId: companiesDailyStats tags: - Analytics parameters: - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: interval in: query schema: type: string enum: - daily - weekly - monthly - name: company_id in: query schema: type: string example: 06745090-506c-4e9a-8c48-286e40b590ed responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/CompaniesDailyStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/documents: get: security: - jwt: [] summary: Documents statistics operationId: documentsStats tags: - Analytics parameters: - name: global_start in: query description: Start date of analytics data schema: type: date example: "2022-01-01" - name: global_end in: query description: End date of analytics data schema: type: date example: "2022-01-31" - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: user_id in: query schema: type: number example: 1 - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: session_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: contact_id in: query schema: type: string example: 1143a56d-cd48-4b15-b021-341eda120241 - name: company_id in: query schema: type: string example: 06745090-506c-4e9a-8c48-286e40b590ed - name: numeric_filters in: query responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/DocumentsStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/documents_daily: get: security: - jwt: [] summary: Documents daily statistics operationId: documentsDailyStats tags: - Analytics parameters: - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: interval in: query schema: type: string enum: - daily - weekly - monthly - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: user_id in: query schema: type: number example: 1 - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: session_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: contact_id in: query schema: type: string example: 1143a56d-cd48-4b15-b021-341eda120241 - name: company_id in: query schema: type: string example: 06745090-506c-4e9a-8c48-286e40b590ed responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/DocumentsDailyStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/pages: get: security: - jwt: [] summary: Pages statistics operationId: pagesStats tags: - Analytics parameters: - name: global_start in: query description: Start date of analytics data schema: type: date example: "2022-01-01" - name: global_end in: query description: End date of analytics data schema: type: date example: "2022-01-31" - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: user_id in: query schema: type: number example: 1 - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: session_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: page_id in: query schema: type: string example: 1 - name: contact_id in: query schema: type: string example: 1143a56d-cd48-4b15-b021-341eda120241 - name: company_id in: query schema: type: string example: 06745090-506c-4e9a-8c48-286e40b590ed - name: numeric_filters in: query responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/PagesStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/pages_daily: get: security: - jwt: [] summary: Pages daily statistics operationId: pagesDailyStats tags: - Analytics parameters: - name: global_user_id in: query schema: type: number example: 1 - name: global_team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: global_meeting_type in: query schema: type: string example: Sales - First meeting - name: interval in: query schema: type: string enum: - daily - weekly - monthly - name: team_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: user_id in: query schema: type: number example: 1 - name: room_id in: query schema: type: string example: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 - name: session_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: document_id in: query schema: type: string example: 6cfa0e97-7db0-41dd-bdd4-1e6f833f4cb8 - name: page_id in: query schema: type: string example: 1 - name: contact_id in: query schema: type: string example: 1143a56d-cd48-4b15-b021-341eda120241 - name: company_id in: query schema: type: string example: 06745090-506c-4e9a-8c48-286e40b590ed responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/PagesDailyStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /accounts/{account}/stats/view: get: security: - jwt: [] summary: Views statistics operationId: viewsStats tags: - Analytics parameters: - name: session_id in: query schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: numeric_filters in: query responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/ViewsStatistics' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /insights/recording/{sessionId}: put: security: - jwt: [] summary: Update recording insights operationId: insightsRecording tags: - Analytics parameters: - name: apiKey in: query required: true schema: type: string responses: 204: description: Successful request 401: description: Access denied /users/{userId}/meetings: get: security: - jwt: [] summary: Get meetings by user operationId: getUserMeetings tags: - Meetings parameters: - name: template in: query type: boolean example: "true" - name: query in: query type: string description: Filter by name - name: start_date in: query description: Filter meeting by date example: "2020-01-01T00:00:00.000Z" - name: end_date in: query description: Filter meeting by date example: "2020-01-01T00:00:00.000Z" responses: 200: description: Successful request content: application/json: schema: type: array items: allOf: - $ref: '#/definitions/Meeting' - type: object properties: created_at: type: string example: '2022-02-03T11:11:08+00:00' 401: description: Access denied 403: description: Access forbidden 404: description: Meeting not found /api/accounts/{accountId}/meetings: post: security: - jwt: [] summary: Create a meeting operationId: createMeeting tags: - Meetings requestBody: content: application/json: schema: allOf: - $ref: '#/requestBodies/Meeting' - type: object properties: new_receivers: type: array items: $ref: '#/requestBodies/DocumentReceiver' integration: type: string default: meetric enum: - meetric - meet - teams created_by: type: number description: Set meeting owner (user_id, only for admin) responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/Meeting' 401: description: Access denied 403: description: Access forbidden 404: description: Meeting not found /accounts/{accountId}/meetings/{meetingId}: put: security: - jwt: [] summary: Edit a meeting operationId: editMeeting tags: - Meetings requestBody: content: application/json: schema: $ref: '#/requestBodies/Meeting' responses: 200: description: Successful request content: application/json: schema: allOf: - type: object - $ref: '#/definitions/Meeting' - properties: pages: type: array items: type: string example: https://example.com/logo.png page_thumbnails: type: array items: type: string example: https://example.com/logo.png 401: description: Access denied 403: description: Access forbidden 404: description: Meeting not found delete: security: - jwt: [] summary: Delete a meeting operationId: deleteMeeting tags: - Meetings responses: 200: description: Successful request 401: description: Access denied 403: description: Access forbidden 404: description: Meeting not found /accounts/{accountId}/stats/meetings/{sessionId}: delete: security: - jwt: [] summary: Delete meeting session operationId: deleteMeetingSession tags: - Meetings responses: 200: description: Successful request 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /meetings/{meetingId}: get: summary: Get single meeting operationId: getMeeting tags: - Meetings responses: 200: description: Successful request content: application/json: schema: type: object $ref: '#/definitions/MeetingPublic' 401: description: Access denied 403: description: Access forbidden 404: description: Meeting not found /meetings/{meetingId}/change_owner: post: summary: Change meeting owner operationId: changeMeetingOwner description: Set meeting owner to current user tags: - Meetings responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/Meeting' 401: description: Access denied 403: description: Access forbidden 404: description: Meeting not found /meetings/{meetingId}/brand: post: security: - jwt: [ ] operationId: uploadMeetingBrand summary: Upload meeting logo and backgound tags: - Meetings requestBody: content: multipart/from-data: schema: type: object properties: logo: type: file description: Max image size is 10 mb background: type: file description: Max image size is 10 mb responses: 200: description: Successful request content: application/json: schema: type: object $ref: '#/definitions/Meeting' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden 404: description: Meeting not found delete: security: - jwt: [ ] operationId: deleteMeetingBranding summary: Delete meeting logo or backgound tags: - Meetings parameters: - name: background in: query description: Remove background image type: boolean - name: logo in: query description: Remove logo image type: boolean responses: 200: description: Successful request content: application/json: schema: type: object $ref: '#/definitions/Meeting' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden 404: description: Meeting not found /meetings/{meeting}/urls: post: security: - jwt: [] summary: Add Url to Meeting operationId: addUrlToMeeting tags: - Meetings requestBody: content: application/json: schema: type: object required: - url properties: url: type: string example: https://www.youtube.com/watch?v=dQw4w9WgXcQ iframe: type: boolean responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/MeetingPublic' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden 404: description: Meeting not found /meetings/{meetingId}/urls/{urlId}: delete: security: - jwt: [ ] summary: Delete Url from Meeting operationId: deleteUrlFromMeeting tags: - Meetings responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/MeetingPublic' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden 404: description: Meeting not found /accounts/{account}/sessions/{sessionId}/timeline: get: security: - jwt: [] summary: Get timeline operationId: getTimeline tags: - Meetings parameters: - name: demo in: query description: Return demo data example: true responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/MeetingTimeline' 403: description: Access forbidden 404: description: Meeting is not found /accounts/{account}/sessions/{sessionId}/timeline/comments: put: security: - jwt: [] summary: Add timeline comment operationId: addTimelineComment tags: - Meetings requestBody: content: application/json: schema: type: object required: - created_by - text - target_time - visible properties: created_by: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 reply_parent_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 text: type: string example: Some sample comment .. target_time: type: number example: 10 visible: type: boolean example: true responses: 200: description: Successful request content: application/json: schema: type: object properties: id: type: string description: Comment ID example: d8d891da-9843-4fb6-b22f-852aa692a862 400: description: Prerequisite failed 403: description: Access forbidden get: security: - jwt: [] summary: Get timeline comments operationId: getTimelineComments tags: - Meetings responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/MeetingTimelineComment' 403: description: Access forbidden /accounts/{account}/meeting-types: get: security: - jwt: [] summary: Get meeting types operationId: getMeetingTypes tags: - Meetings responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/MeetingTypes' 403: description: Access forbidden /accounts/{account}/meeting-types/{typeId}: put: security: - jwt: [] summary: Update meeting type operationId: updateMeetingType tags: - Meetings requestBody: content: application/json: schema: type: object required: - name properties: name: type: string example: Some Meeting Type target_engagement: type: number example: 95 target_talk_listen_ratio: type: number example: 65 target_shifts_per_minute: type: number example: 10 responses: 204: description: Successful request 401: description: Access denied 404: description: Bad request /accounts/{accountId}/branding: get: security: - jwt: [] summary: Get branding by account operationId: getBranding tags: - Branding responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/Branding' 401: description: Access denied 403: description: Access forbidden 404: description: Branding not found post: security: - jwt: [] summary: Add a branding operationId: postBranding tags: - Branding requestBody: content: application/json: schema: type: object $ref: '#/requestBodies/Branding' responses: 200: description: Successful request content: application/json: schema: type: object $ref: '#/definitions/Branding' 401: description: Access denied 403: description: Access forbidden 404: description: Branding not found /accounts/{accountId}/branding/{brandingId}: put: security: - jwt: [] summary: Edit a branding operationId: editBranding tags: - Branding requestBody: content: application/json: schema: type: object $ref: '#/requestBodies/Branding' responses: 200: description: Successful request content: application/json: schema: type: object $ref: '#/definitions/Branding' 401: description: Access denied 403: description: Access forbidden 404: description: Branding not found delete: security: - jwt: [] summary: Delete a branding operationId: deleteBranding tags: - Branding responses: 200: description: Successful request 401: description: Access denied 403: description: Access forbidden 404: description: Branding not found /branding/{brandingId}: post: security: - jwt: [ ] operationId: uploadBranding summary: Upload braning logo and backgound tags: - Branding requestBody: content: multipart/from-data: schema: type: object properties: logo: type: file description: Max image size is 10 mb background: type: file description: Max image size is 10 mb responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/Branding' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden 404: description: Branding not found delete: security: - jwt: [ ] operationId: deleteBrandingImage summary: Delete braning logo or backgound tags: - Branding parameters: - name: background in: query description: Remove background image type: boolean - name: logo in: query description: Remove logo image type: boolean responses: 200: description: Successful request content: application/json: schema: type: object $ref: '#/definitions/Branding' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden 404: description: Branding not found /recordings: post: security: - jwt: [ ] summary: Create a recording operationId: createRecording tags: - Recordings requestBody: content: application/json: schema: type: object required: - url - session_id - meeting_id - account_id properties: url: type: string example: https://placeholder.com/200 session_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 meeting_id: type: string example: 4a53d3e5-20ad-4c4d-a518-f13a42626e39 account_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 start_time: type: string example: 2020-01-01T00:00:00.000Z end_time: type: string example: 2020-01-01T00:00:00.000Z audio: type: array items: type: object required: - participant_id - url - started_at properties: participant_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 description: user ID or receiver ID url: type: string example: https://placeholder.com/200 started_at: type: string format: date-time responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/Recording' 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden /recordings/sessions/{sessionId}: get: security: - jwt: [ ] summary: Get recordings by session operationId: recordingsBySesson tags: - Recordings responses: 200: description: Successful request content: application/json: schema: type: object properties: url: type: string example: https://example.com/image.mp4 screenshots: type: array items: type: string example: https://example.com/image.png /recordings/{recordingId}: delete: security: - jwt: [ ] summary: Delete a recording operationId: deleteRecording tags: - Recordings responses: 200: description: Successful request 404: description: Recording not found /google-meet/login: get: security: - jwt: [ ] summary: Add Google Meet account to current user operationId: googleMeetLogin description: Returns URL for Google modal tags: - Google Meet responses: 200: description: Successful request content: application/json: schema: type: object properties: url: type: string 401: description: Access denied /google-meet/login/check: get: security: - jwt: [ ] summary: Finish adding Google Meet account operationId: googleMeetLoginFinish tags: - Google Meet parameters: - name: code in: query required: true description: Code from Google responses: 200: description: Successful request content: application/json: schema: type: object 401: description: Access denied /ms-teams/login: get: security: - jwt: [ ] summary: Add Microsoft teams account to current user operationId: msTeamsLogin description: Returns URL for MS Teams modal tags: - Microsoft teams responses: 200: description: Successful request content: application/json: schema: type: object properties: url: type: string 401: description: Access denied /ms-teams/login/check: get: security: - jwt: [ ] summary: Finish adding Microsoft teams account operationId: msTeamsLoginFinish tags: - Microsoft teams parameters: - name: code in: query required: true description: Code from MS Teams responses: 200: description: Successful request content: application/json: schema: type: object 401: description: Access denied /account_rights: post: security: - jwt: [ ] summary: Create Account rights operationId: CreateAccountRights tags: - Account rights requestBody: content: application/json: schema: allOf: - type: object - required: - account_id - right_type - level - scope properties: account_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - $ref: '#/requestBodies/AccountRights' responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/AccountRights' 400: $ref: '#/definitions/BadRequest' 401: description: Access denied 403: description: Access forbidden get: security: - jwt: [ ] summary: Get list operationId: getListAccountRights tags: - Account rights parameters: - name: account_id in: query example: d8d891da-9843-4fb6-b22f-852aa692a862 required: true responses: 200: description: Successful request content: application/json: schema: type: array items: $ref: '#/definitions/AccountRights' 400: $ref: '#/definitions/BadRequest' 401: description: Access denied 403: description: Access forbidden /account_rights/{rightId}: put: security: - jwt: [] summary: Edit Account Rights operationId: editAccountRights tags: - Account rights requestBody: content: application/json: schema: $ref: '#/requestBodies/AccountRights' responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/AccountRights' 400: $ref: '#/definitions/BadRequest' 403: description: Access forbidden 404: description: AccountRights is not found delete: security: - jwt: [] summary: Delete Account Rights operationId: deleteAccountRights tags: - Account rights responses: 200: description: Successful request 400: description: Prerequisite failed 401: description: Access denied 403: description: Access forbidden 404: description: AccountRights not found /integrations/{crmName}/accounts/{account}/{receiver}: get: security: - jwt: [] summary: Receiver data from CRM operationId: getReceiverDataFromCRM tags: - CRM Integrations parameters: - name: account in: path schema: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - name: crmName in: path schema: type: string enum: - microsoft-dynamics - name: receiver in: path schema: type: string example: 04949ce4-a160-4768-84dc-64a1011b400e responses: 200: description: Successful request content: application/json: schema: $ref: '#/definitions/ReceiverDataFromCRM' 400: description: Bad request 404: description: Receiver not found /integrations/microsoft-dynamics: post: security: - jwt: [] summary: Integrate Microsoft Dynamics operationId: integrateMicrosoftDynamics tags: - CRM Integrations requestBody: content: application/json: schema: type: object $ref: '#/requestBodies/IntegrateMicrosoftDynamics' required: - account_id - organization_url - client_id - client_secret - process_old_crm_data properties: account_id: type: string organization_url: type: string client_id: type: string client_secret: type: string process_old_crm_data: type: boolean responses: 200: description: Successful request content: application/json: {} 400: description: Bad request /upsales/users: get: security: - jwt: [ ] summary: Get upsales users operationId: upsalesUsers tags: - CRM Integrations parameters: - name: token in: query required: true description: Upsales token (API key) responses: 200: description: Successful request content: application/json: schema: type: array items: type: object properties: id: type: number example: 1 name: type: string example: Peter Parker email: type: string example: parker@example.com 400: description: Prerequisite failed 401: description: Access denied /upsales/token: post: security: - jwt: [ ] summary: Add upsales token operationId: addUpsalesToken tags: - CRM Integrations requestBody: content: application/json: schema: type: object required: - token - user_id properties: token: type: string description: Upsales token (API key) user_id: type: number description: Upsales user_id (see `GET /api/upsales/users`) example: 1 responses: 204: description: Successful request 400: description: Prerequisite failed 401: description: Access denied /send-sms: post: security: - jwt: [] summary: Send SMS operationId: sendSMS tags: - SMS requestBody: content: application/json: schema: type: object required: - phone_number - meeting_link properties: phone_number: type: string example: +123456789 meeting_link: type: string example: https://example.com/ responses: 201: description: Successful request 400: description: Invalid phone number 403: description: Access forbidden /conference-usage: post: security: - jwt: [] summary: Add conference usage statistics operationId: conferenceUsage tags: - Conference usage requestBody: content: application/json: schema: type: object required: - calendar_type - chosen_conference - account_id properties: calendar_type: type: string chosen_conference: type: string account_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 responses: 200: description: Successful request content: application/json: schema: type: object properties: id: type: string 400: $ref: '#/definitions/BadRequest' 401: description: Access denied 403: description: Access forbidden requestBodies: IntegrateMicrosoftDynamics: properties: account_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 organization_url: type: string example: https://org3137ca24.crm4.dynamics.com client_id: type: string example: 80b04b0a-5951-477b-a5f6-e3de48f17f84 client_secret: type: string example: Art7Q~kcDmMtpBGZfv6nHPWrYKRNjVgWiazRF process_old_crm_data: type: boolean example: true AccountRights: properties: right_type: type: string enum: - statistics - documents - recordings - meetings level: type: string enum: - read - write scope: type: string enum: - own - team - account users: type: array example: [ 5, 77 ] items: type: integer teams: type: array example: [ '4a53d3e5-20ad-4c4d-a518-f13a42626e39' ] items: type: string all_users: default: false type: boolean Presentation: type: object required: - name - account_id properties: name: type: string example: Test account_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 tags: type: array example: - tag1 - tag2 category_ids: type: array example: - d8d891da-9843-4fb6-b22f-852aa692a862 - d8d891da-9843-4fb6-b22f-852aa692a863 template: type: boolean default: false custom_variables: type: object example: key1: "value1" abc: "321" folder_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 nullable: true User: type: object properties: username: type: string example: test password: type: string example: '12345' email: type: string example: test@meetric.com first_name: type: string example: Joe last_name: type: string example: Doe profile_picture_url: type: string example: https://placeholder.com/200 mobile_number: type: string example: '0 (111) 253 444' settings: type: object description: An arbitary json object Team: type: object required: - account_id - name - description properties: name: type: string example: Foo team description: type: string example: Test team account_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 settings: type: object description: An arbitary json object UserRight: type: object properties: object_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 right_type: type: string example: presentation right_level: type: string example: write user_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 Right: type: object required: - object_id - right_type - right_level properties: object_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 right_type: type: string enum: - presentation - file - room - folder right_level: type: string example: write enum: - read - write team_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 Account: type: object allOf: - $ref: '#/definitions/AccountFull' - required: - name - company_name - type: object properties: domain: type: string example: test Slide: type: object required: - name - presentation_id - width - height - slide_content - slide_position properties: name: type: string example: test presentation_id: type: string example: 4a53d3e5-20ad-4c4d-a518-f13a42626e39 description: Should be provided only for global slides width: type: integer example: 100 height: type: integer example: 100 type: type: string description: default: single enum: - single - global slide_content: type: object slide_style: type: object animations: type: object raw_html: type: string Analytics: type: object required: - event_type - event_name - event_value - event_time - user_agent - mode - receiver_id - sharable_token - owner_id properties: receiver_id: type: string example: 351e6aaf-b09f-4e6e-b29e-51ebc372b0f0 description: Required only for anonymous sharable_token: type: string example: 351e6aaf-b09f-4e6e-b29e-51ebc372b0f0 description: Required only for anonymous owner_id: type: number description: User ID event_type: type: string event_name: type: string event_value: type: integer event_time: type: integer user_agent: type: string mode: type: string example: meeting is_presenter: type: boolean description: Ignored if user is anonymous. Default is `false` account_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 room_id: type: string description: Room id session_id: type: string example: 4a53d3e5-20ad-4c4d-a518-f13a42626e39 event_description: type: string document_id: type: string description: File or Presentation ID document_page: type: string presentation_id: type: string example: 4a53d3e5-20ad-4c4d-a518-f13a42626e39 meeting_id: type: string example: 4a53d3e5-20ad-4c4d-a518-f13a42626e39 meeting_type: type: string example: Sales - First meeting slide_id: type: string example: 4a53d3e5-20ad-4c4d-a518-f13a42626e39 url_id: type: string example: 4a53d3e5-20ad-4c4d-a518-f13a42626e39 view_id: type: string example: 4a53d3e5-20ad-4c4d-a518-f13a42626e39 interactions: type: integer example: 3 interaction_time: type: integer example: 42 talking: type: array items: type: number example: [5, 06, 19.86] clicks: type: integer example: 42 links_clicked: type: integer example: 42 mouse_move_amount: type: integer example: 123456 SharePresentation: type: object properties: company_name: type: string example: Some company custom_variables: type: object example: key1: "value1" abc: "321" anonymous_receiver: type: boolean DocumentReceiver: type: object properties: first_name: type: string last_name: type: string phone: type: string email: type: string position: type: string DocumentReceiverWithAccount: type: object required: - account_id allOf: - type: object properties: account_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 - $ref: '#/requestBodies/DocumentReceiver' Meeting: type: object properties: name: type: string example: Name type: type: string nullable: true company: type: string example: Company duration: type: number example: 123 tags: type: array items: type: string example: tag template: type: boolean default: false template_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 description: ID of template meeting meeting_forward: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 nullable: true start_time: type: string format: date-time edited: type: boolean files: type: array description: ID of files items: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 presentations: type: array description: ID of presentations items: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 receivers: type: array description: ID of receivers items: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 chat_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 background: type: object description: An arbitary json object example: background-color: "#000" branding_id: type: string nullable: true description: ID of Branding object or null example: d8d891da-9843-4fb6-b22f-852aa692a862 room_id: type: string nullable: true example: d8d891da-9843-4fb6-b22f-852aa692a862 note: type: string example: Note nullable: true Branding: type: object properties: name: type: string example: Name default: type: boolean background: type: object description: An arbitary json object example: background-color: "#000" Room: required: - name type: object properties: name: type: string params: description: An arbitary json object type: object participants: type: array items: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 users: type: array example: [1, 2, 3] items: type: integer files: type: array description: ID of files items: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 presentations: type: array description: ID of presentations items: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 chat_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 branding_id: type: string nullable: true description: ID of Branding object or null example: d8d891da-9843-4fb6-b22f-852aa692a862 background: type: object description: An arbitary json object example: background-color: "#000" template: type: boolean default: false definitions: User: type: object properties: id: type: integer example: 1 username: type: string format: unsigned example: yolo@yolo.com email: type: string format: unsigned example: yolo@yolo.com first_name: type: string example: Joe last_name: type: string example: Doe profile_picture_url: type: string example: https://placeholder.com/200 mobile_number: type: string example: 01231232132131 teams: type: array items: type: object $ref: '#/definitions/Team' accounts: type: array items: type: object $ref: '#/definitions/Account' last_login: type: string format: date-time example: 2020-08-13T13:16:21Z UserBasic: type: object properties: id: type: integer example: 1 first_name: type: string example: Joe last_name: type: string example: Doe Slide: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 name: type: string example: Test slide_content: type: object description: An arbitary json object slide_style: type: object description: An arbitary json object animations: type: object description: An arbitary json object slide_position: type: integer example: 1 height: type: string example: 500 width: type: string example: 600 created_at: type: string format: date-time example: 2020-08-13T13:16:21Z SlideWithPosition: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 name: type: string example: Test slide_content: type: object description: An arbitary json object slide_position: type: integer example: 1 height: type: string example: 500 width: type: string example: 600 type: type: string enum: - single - global raw_html: type: string created_at: type: string format: date-time example: 2020-08-13T13:16:21Z Category: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 name: type: string example: Test Presentation: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 name: type: string format: unsigned example: Product XY pitchdec tags: type: array format: array example: ["tag1", "tag2"] categories: type: array items: $ref: '#/definitions/Category' account: type: object $ref: '#/definitions/Account' last_updated: type: string format: date-time example: 2020-08--13T13:16:21Z slides: type: array items: $ref: '#/definitions/SlideWithPosition' template: type: boolean TeamBasic: type: object properties: id: type: string example: d3f65c3e-811c-4e4b-8439-415f1ba4e8de name: type: string example: Foo team Team: type: object properties: id: type: string example: d3f65c3e-811c-4e4b-8439-415f1ba4e8de name: type: string example: Foo team account: type: object example: id: d3f65c3e-811c-4e4b-8439-415f1ba4e8de name: Company managers: type: array items: type: object example: id: 1 first_name: John last_name: Smith description: type: string example: Foo bar created_at: type: string format: date-time example: 2020-08--13T13:16:21Z Right: type: object properties: id: type: string example: d3f65c3e-811c-4e4b-8439-415f1ba4e8de right_level: type: string example: edit user: type: object $ref: '#/definitions/User' team: type: object $ref: '#/definitions/Team' account: type: object $ref: '#/definitions/Account' right_given_by: type: object $ref: '#/definitions/User' right_type: type: string example: presentation created_at: type: string format: date-time example: 2020-08--13T13:16:21Z AccountRights: type: object properties: id: type: string example: d3f65c3e-811c-4e4b-8439-415f1ba4e8de basic: type: boolean right_type: type: string example: statistics level: type: string example: read scope: type: string example: team users: type: array items: $ref: '#/definitions/UserBasic' teams: type: array items: $ref: '#/definitions/TeamBasic' all_users: type: boolean example: true Account: type: object properties: id: type: string example: d3f65c3e-811c-4e4b-8439-415f1ba4e8de name: type: string example: Test account right_level: type: string example: user AccountFull: type: object properties: name: type: string example: Test company_name: type: string example: Test company_city: type: string example: Los-Angeles company_state: type: string example: California company_postcode: type: string example: 012345 company_registration: type: string example: Some string company_language: type: string example: EN company_timezone: type: string example: PST company_currency: type: string example: USD company_vat: type: string example: 0.1 company_main_contact: type: string example: John Does company_phone: type: string example: 000 (000) 000-000 logo_img: type: string example: https://example.com/logo.png background_img: type: string example: https://example.com/logo.png background: type: object description: An arbitary json object example: background-color: "#000" settings: type: object description: An arbitary json object form_link: type: string is_beta: type: boolean example: "false" Receiver: type: object properties: id: type: string example: d3f65c3e-811c-4e4b-8439-415f1ba4e8de first_name: type: string example: Test last_name: type: string example: Test company_name: type: string example: Test phone: type: string example: 1234567890 email: type: string example: test@meetric.com position: type: string example: test SingleReceiver: type: object properties: id: type: string example: d3f65c3e-811c-4e4b-8439-415f1ba4e8de email: type: string example: test@meetricMe.com first_name: type: string example: Test last_name: type: string example: Test File: type: object properties: id: type: string example: d3f65c3e-811c-4e4b-8439-415f1ba4e8de mime_type: type: string example: text type: type: string example: private filetype: $ref: '#/definitions/FileType' uploaded_by: type: object $ref: '#/definitions/User' path: type: string filename: type: string example: test.pdf created_at: type: string format: date-time example: 2020-08--13T13:16:21Z thumbnail: type: string FileType: type: string enum: - image - gif - video - pdf - other ImageSearchResponse: type: object properties: images: type: array items: type: object properties: urls: type: object example: full: https://example.com/image.jpg thumb: https://example.com/thumbnail.jpg title: type: string example: Some title author: type: string example: John Smith category: type: string example: nature tags: type: array example: - tag1 - tag2 pagintaion: type: object properties: results: type: int example: 12667 limit: type: int example: 20 page: type: int example: 1 BadRequest: description: Prerequisite failed content: application/json: schema: type: object properties: errors: description: List of request fields that failed validation type: object example: email: This value is not a valid email address. last_name: This value should not be blank. Analytics: type: object properties: id: type: string example: "019822c6-54ca-4478-95c8-9b39ed2d581a" event_type: type: string event_name: type: string event_value: type: integer event_description: type: string event_time: type: integer user_agent: type: string created_at: example: "2020-09-22T10:51:07+00:00" SharedPresentation: type: object properties: sharable_token: type: string example: e9b518aa-ccbc-407b-a1de-f2a0ade2ae33 company_name: type: string example: Company custom_variables: type: object example: key1: "value1" abc: "321" anonymous_receiver: type: boolean shared_by: type: number example: 1 SharedPresentationFull: type: object allOf: - $ref: '#/definitions/Presentation' - $ref: '#/definitions/SharedPresentation' ReceiverDataFromCRM: type: object properties: id: type: string example: 80ac35a0-01af-ea11-a812-000d3a8b3ec6 first_name: type: string example: Alex last_name: type: string example: Baker email: type: string example: alex@treyresearch.net mobile_phone: type: string example: 619-555-0129 timeline: type: array example: - activity_type: annotation start: 1/30/2022 11:00 AM subject: Review the final quotation duration: 30 (minutes) - activity_type: appointment start: 1/29/2022 10:00 AM subject: Discussion on the Service Warranty Trey Research is Entitled to duration: 60 (minutes) DocumentReceivers: type: array items: type: object properties: id: type: string example: c6d1dbe1-9d79-4542-b4d5-829328bd935b first_name: type: string example: First last_name: type: string example: Last phone: type: string email: type: string position: type: string TeamStatistics: type: array example: - team_id: d8d891da-9843-4fb6-b22f-852aa692a862 team_name: Outbound HK meetings: 3 avg_meeting_time: 2760 avg_slides_shown: 2 face2face_percentage: 55.1 direct_share_percentage: 24.1 screen_share_percentage: 20.1 meeting_score: 84.2 meeting_engagement_percentage: 69.1 room_engagement_percentage: 58.1 avg_division: 75.1 avg_shifts_per_minute: 2.05 avg_interruptions: 12 TeamDailyStatistics: type: array example: - date: "2022-01-30" meetings: 4 meeting_time: 127.6 average_meeting_engagement: 96.1 documents_shown: 5 - date: "2022-01-31" meetings: 5 meeting_time: 133.9 average_meeting_engagement: 73.2 documents_shown: 4 UserStatistics: type: array example: - user_id: 11 user_first_name: Philip user_last_name: Örnborg meetings: 3 avg_meeting_time: 2760 avg_slides_shown: 2 face2face_percentage: 55.1 direct_share_percentage: 24.1 screen_share_percentage: 20.1 meeting_score: 84.2 meeting_engagement_percentage: 69.1 room_engagement_percentage: 58.1 avg_division: 75.1 avg_shifts_per_minute: 2.05 avg_interruptions: 12 UserDailyStatistics: type: array example: - date: "2022-01-30" meetings: 4 meeting_time: 127.6 average_meeting_engagement: 96.1 documents_shown: 5 - date: "2022-01-31" meetings: 5 meeting_time: 133.9 average_meeting_engagement: 73.2 documents_shown: 4 MeetingsStatistics: type: array example: - id: 4a53d3e5-20ad-4c4d-a518-f13a42626e39 name: Meeting with Customer user: { id: 1, first_name: Philip, last_name: Örnborg } session_id: d8d891da-9843-4fb6-b22f-852aa692a862 company_domains: [ { id: 100ec731-6419-49d8-9432-e17b6dc606e5, name: Google } ] participants: [ { id: 83a47d0f-68d1-4213-93aa-26f4618b03e9, first_name: Valerie, last_name: Anderson }, { id: 9fb1c286-ac65-4a3c-9464-a6bc7af41f83, first_name: Doreen, last_name: Bedford } ] date: 2021-12-25 14:23:30 meeting_time: 2760 slides_shown: 2 face2face_percentage: 86.1 direct_share_percentage: 54.1 screen_share_percentage: 23.1 meeting_score: 84.2 meeting_engagement_percentage: 85.1 division: 100 shifts_per_minute: 2.05 interruptions: 12 has_recording: true MeetingsLiveStatistics: type: array example: - id: 4a53d3e5-20ad-4c4d-a518-f13a42626e39 name: Meeting with Customer user: { id: 1, first_name: Philip, last_name: Örnborg } session_id: d8d891da-9843-4fb6-b22f-852aa692a862 participants: [ { id: 83a47d0f-68d1-4213-93aa-26f4618b03e9, first_name: Valerie, last_name: Anderson }, { id: 9fb1c286-ac65-4a3c-9464-a6bc7af41f83, first_name: Doreen, last_name: Bedford } ] date: 2021-12-25 14:23:30 meeting_time: 2760 MeetingsDailyStatistics: type: array example: - date: "2022-01-30" meetings: 4 meeting_time: 127.6 average_meeting_engagement: 96.1 - date: "2022-01-31" meetings: 5 meeting_time: 133.9 average_meeting_engagement: 73.2 RoomsStatistics: type: array example: - room_id: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 room_name: Chat user_id: 1 user_first_name: Philip user_last_name: Örnborg company_domains: [ { id: 100ec731-6419-49d8-9432-e17b6dc606e5, name: Google } ] members: [ { id: 83a47d0f-68d1-4213-93aa-26f4618b03e9, first_name: Valerie, last_name: Anderson }, { id: 9fb1c286-ac65-4a3c-9464-a6bc7af41f83, first_name: Doreen, last_name: Bedford } ] date: 2021-12-25 14:23:30 documents_shown: 3 pages_shown: 16 page_views: 14 document_time: 2760 room_engagement_percentage: 85.1 clicks: 146 links_clicked: 10 RoomsDailyStatistics: type: array example: - date: "2022-01-30" rooms_created: 2 room_sessions: 5 documents_shown: 4 pages_shown: 16 room_engagement_percentage: 86.1 - date: "2022-01-31" rooms_created: 1 room_sessions: 6 documents_shown: 4 pages_shown: 15 room_engagement_percentage: 85.2 RoomSessionsStatistics: type: array example: - session_id: 80e3a47a-c31f-346d-a5df-33ceb4e19d72 room_id: 9bf703da-de37-3ea5-bcc0-bbc5c325eaf6 room_name: Chat user_id: 1 user_first_name: Philip user_last_name: Örnborg company_id: 100ec731-6419-49d8-9432-e17b6dc606e5 company: Google member_id: 83a47d0f-68d1-4213-93aa-26f4618b03e9 member_first_name: Valerie member_last_name: Anderson date: 2021-12-25 14:23:30 documents_shown: 3 pages_shown: 16 page_views: 14 document_time: 2760 room_engagement_percentage: 85.1 clicks: 146 links_clicked: 10 RoomSessionsDailyStatistics: type: array example: - date: "2022-01-30" rooms_created: 2 room_sessions: 5 documents_shown: 4 pages_shown: 16 room_engagement_percentage: 86.1 - date: "2022-01-31" rooms_created: 1 room_sessions: 6 documents_shown: 4 pages_shown: 15 room_engagement_percentage: 85.2 ParticipantsStatistics: type: array example: - participant_id: 203c67fb-c3ed-4b27-b10f-ea75db5e3106 first_name: Valerie last_name: Anderson email: valerie@google.com company_id: 224673f7-c78f-4e1e-8f07-14f1c6f4766d company: Google time_in_meetings: 2760 documents_shown: 14 pages_shown: 28 page_views: 28 document_time: 2760 clicks: 45 links_clicked: 7 meeting_engagement_percentage: 88.1 avg_division: 75.1 avg_shifts_per_minute: 2.05 avg_interruptions: 12 ParticipantsDailyStatistics: type: array example: - date: "2022-01-30" new_participants: 2 interactions: 5 - date: "2022-01-31" new_participants: 3 interactions: 7 MembersStatistics: type: array example: - member_id: 203c67fb-c3ed-4b27-b10f-ea75db5e3106 first_name: Danielle last_name: Moore email: danielle@pepsi.com company_id: 224673f7-c78f-4e1e-8f07-14f1c6f4766d company: Pepsi time_in_rooms: 2760 documents_shown: 18 pages_shown: 35 page_views: 35 document_time: 1238 clicks: 86 links_clicked: 4 room_engagement_percentage: 93.1 MembersDailyStatistics: type: array example: - date: "2022-01-30" new_members: 2 interactions: 5 - date: "2022-01-31" new_members: 3 interactions: 7 ContactsStatistics: type: array example: - contact_id: 203c67fb-c3ed-4b27-b10f-ea75db5e3106 first_name: Danielle last_name: Moore email: danielle@pepsi.com company_id: 224673f7-c78f-4e1e-8f07-14f1c6f4766d company: Pepsi time_in_meetings: 2760 time_in_rooms: 2760 times_in_meetings: 5 times_in_rooms: 6 average_engagement_meetings: 89.1 average_engagement_rooms: 88.2 avg_division: 75.1 avg_shifts_per_minute: 2.05 avg_interruptions: 12 ContactsDailyStatistics: type: array example: - date: "2022-01-30" new_contacts: 2 interactions: 5 - date: "2022-01-31" new_contacts: 3 interactions: 7 CompaniesStatistics: type: array example: - company_id: 224673f7-c78f-4e1e-8f07-14f1c6f4766d company: Pepsi time_in_meetings: 2760 time_in_rooms: 2760 times_in_meetings: 5 times_in_rooms: 6 average_engagement_meetings: 89.1 average_engagement_rooms: 88.2 avg_division: 75.1 avg_shifts_per_minute: 2.05 avg_interruptions: 12 CompaniesDailyStatistics: type: array example: - date: "2022-01-30" new_companies: 2 interactions: 5 - date: "2022-01-31" new_companies: 3 interactions: 7 DocumentsStatistics: type: array example: - user_id: 32f510ef-8345-42b0-849e-bb58ce6eabfd user_first_name: Danielle user_last_name: Moore document_id: 41a2395b-6814-45de-9a56-008158d48670 thumbnail: "..." document_name: Demo Presentation document_type: pptx times_shown: 9 pages_shown: 9 page_views: 18 document_time: 2760 document_time_meetings: 1760 document_time_rooms: 1000 document_avg_time: 2760 document_avg_time_meetings: 2760 document_avg_time_rooms: 2760 average_engagement_meetings: 43.1 average_engagement_rooms: 78.2 times_used_in_meetings: 5 times_used_in_rooms: 4 DocumentsDailyStatistics: type: array example: - date: "2022-01-30" documents_shown: 3 document_time: 41.7 document_time_meetings: 32.9 document_time_rooms: 8.8 document_avg_time: 41.7 document_avg_time_meetings: 32.9 document_avg_time_rooms: 8.8 average_engagement_meetings: 76.1 average_engagement_rooms: 78.2 amount_used_in_meetings: 2 amount_used_in_rooms: 3 - date: "2022-01-31" documents_shown: 3 document_time: 41.7 document_time_meetings: 32.9 document_time_rooms: 8.8 document_avg_time: 41.7 document_avg_time_meetings: 32.9 document_avg_time_rooms: 8.8 average_engagement_meetings: 76.1 average_engagement_rooms: 78.2 amount_used_in_meetings: 2 amount_used_in_rooms: 3 PagesStatistics: type: array example: - user_id: 32f510ef-8345-42b0-849e-bb58ce6eabfd user_first_name: Carla user_last_name: Thomas thumbnail: "..." document_id: 41a2395b-6814-45de-9a56-008158d48670 document_name: Demo Presentation document_type: pptx page_id: 1 page_name: Page 1 times_shown: 8 page_views: 10 page_time: 2760 page_time_meetings: 1760 page_time_rooms: 1000 page_avg_time: 2760 page_avg_time_meetings: 2760 page_avg_time_rooms: 2760 average_engagement_meetings: 43.1 times_used_in_meetings: 5 times_used_in_rooms: 4 PagesDailyStatistics: type: array example: - date: "2022-01-30" pages_shown: 14 page_views: 14 page_time: 41.7 page_time_meetings: 32.9 page_time_rooms: 8.8 page_avg_time: 41.7 page_avg_time_meetings: 32.9 page_avg_time_rooms: 8.8 average_engagement_meetings: 76.1 amount_used_in_meetings: 2 amount_used_in_rooms: 3 - date: "2022-01-31" pages_shown: 14 page_views: 14 page_time: 41.7 page_time_meetings: 32.9 page_time_rooms: 8.8 page_avg_time: 41.7 page_avg_time_meetings: 32.9 page_avg_time_rooms: 8.8 average_engagement_meetings: 76.1 amount_used_in_meetings: 2 amount_used_in_rooms: 3 ViewsStatistics: type: array example: - start_time: 2021-12-25 14:23:30 document_name: Demo Presentation page: Page 1 view_time: 2760 meeting_engagement_percentage: 87.2 Note: type: object properties: id: type: string example: 351e6aaf-b09f-4e6e-b29e-51ebc372b0f0 content: type: string note_type: type: string enum: - personal - global slide_id: type: string example: 351e6aaf-b09f-4e6e-b29e-51ebc372b0f0 created_at: type: string format: date-time example: 2020-11-03T16:59:25+00:00 FileNote: type: object properties: id: type: string example: 351e6aaf-b09f-4e6e-b29e-51ebc372b0f0 content: type: string page: type: number example: 1 created_at: type: string format: date-time example: 2020-11-03T16:59:25+00:00 AccountRight: type: string enum: - user - manage_users - admin Font: type: object properties: id: type: string example: 1ce08155-a7ad-4d7e-929e-a1974d745659 font_name: type: string example: Roboto font_weight: type: number example: 400 italic: type: boolean url: type: string SlideTemplate: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 name: type: string example: Test slide_content: type: object description: An arbitary json object slide_style: type: object description: An arbitary json object height: type: string example: 500 width: type: string example: 600 created_at: type: string format: date-time example: 2020-08-13T13:16:21Z Meeting: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 name: type: string example: Name type: type: string nullable: true company: type: string example: Company duration: type: number example: 123 tags: type: array items: type: string example: tag template: type: boolean meeting_template: $ref: '#/definitions/Meeting' start_time: type: string format: date-time example: 2020-08-13T13:16:21Z edited: type: boolean files: type: array items: type: object example: id: 88503b02-28aa-4f30-9564-25051872f28a mime_type: image/png filetype: image path: https://example.com/thumbnail.jpg filename: thumbnail.jpg presentations: type: array example: id: 88503b02-28aa-4f30-9564-25051872f28a name: Presentation logo_img: type: string example: https://example.com/logo.png background_img: type: string example: https://example.com/logo.png background: type: object description: An arbitary json object example: background-color: "#000" branding_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 room_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 nullable: true MeetingTimeline: type: object properties: participant: allOf: - $ref: '#/definitions/SingleReceiver' - type: object properties: type: type: string enum: - user - presenter - receiver engagement: type: array items: type: object example: start: 0 end: 2 status: active talking: type: array items: type: object example: start: 2 end: 4 interruptions: type: array items: type: number example: 3 questions: type: array items: type: number example: 7.55 MeetingTimelineComment: type: array example: - id: d8d891da-9843-4fb6-b22f-852aa692a862 created_by: [ { id: 100ec731-6419-49d8-9432-e17b6dc606e5, first_name: Philip, last_name: Örnborg } ] reply_parent_id: d8d891da-9843-4fb6-b22f-852aa692a862 text: Some sample comment .. created_at: 2021-12-25 14:23 target_time: 10 MeetingTypes: type: array example: - id: d8d891da-9843-4fb6-b22f-852aa692a862 name: Sales - Follow-up - id: 88503b02-28aa-4f30-9564-25051872f28a name: HR MeetingAIAnalytics: type: object properties: participant: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 first_name: type: string example: Philip last_name: type: string example: Örnborg type: type: string enum: - user - presenter - receiver meeting_score: type: number example: 84.2 meeting_engagement_percentage: type: number example: 62.1 division: type: number example: 53.1 shifts_per_minute: type: number example: 2.05 interruptions: type: integer example: 12 MeetingPublic: type: object allOf: - $ref: '#/definitions/Meeting' - type: object properties: created_by_id: type: number example: 1 account_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 chat_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 internal_chat_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 domain: type: string example: test nullable: true account_settings: type: object pages: type: array items: type: string example: https://example.com/logo.png page_thumbnails: type: array items: type: string example: https://example.com/logo.png note: type: string example: Note nullable: true urls: type: array items: $ref: '#/definitions/Url' used: type: boolean meeting_forward: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 nullable: true integraton: type: string example: meetric external_url: type: string nullable: true example: https://example.com form_link: type: string nullable: true Branding: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 name: type: string example: Name default: type: boolean logo_img: type: string example: https://example.com/logo.png background_img: type: string example: https://example.com/logo.png background: type: object description: An arbitary json object example: background-color: "#000" Resources: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 title: type: string example: Some title description: type: string example: Foo bar some description text: type: string example: Foo bar some text files: type: array items: $ref: '#/definitions/File' category: type: string example: Some category tags: type: array format: string example: [ "tag1", "tag2" ] Room: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 name: type: string files: type: array items: type: object example: id: 88503b02-28aa-4f30-9564-25051872f28a mime_type: image/png filetype: image filename: thumbnail.jpg path: https://example.com/thumbnail.jpg presentations: type: array items: example: id: 88503b02-28aa-4f30-9564-25051872f28a name: Presentation params: description: An arbitary json object type: object logo_img: type: string example: https://example.com/logo.png background_img: type: string example: https://example.com/logo.png background: type: object description: An arbitary json object example: background-color: "#000" template: type: boolean RoomPublic: type: object allOf: - $ref: '#/definitions/Room' - type: object properties: account_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 domain: type: string nullable: true example: test chat_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 internal_chat_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 owner: type: object properties: id: type: number example: 1 first_name: type: string last_name: type: string participants: type: array items: $ref: '#/definitions/Receiver' users: type: array items: $ref: '#/definitions/UserBasic' pages: type: array items: type: string example: https://example.com/logo.png urls: type: array items: $ref: '#/definitions/Url' Url: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 title: type: string example: GitHub oscarotero/Embed - Get info from any web service or page description: type: string example: Get info from any web service or page. Contribute to oscarotero/Embed development by creating an account on GitHub. url: type: string example: https://www.youtube.com/watch?v=dQw4w9WgXcQ iframe: type: boolean thumbnail: type: string example: https://opengraph.githubassets.com/ee278b42f8d56d842e43d49f4f3284604dcfbdc00deae239d40132cdccd9b8b2/oscarotero/Embed favicon: type: string example: https://github.githubassets.com/favicons/favicon.svg Folder: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 name: type: string FolderWithData: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 name: type: string folders: type: array items: $ref: '#/definitions/Folder' files: type: array items: $ref: '#/definitions/File' presentations: type: array items: $ref: '#/definitions/Presentation' Recording: type: object properties: id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 url: type: string example: https://example.com/image.jpg session_id: type: string example: d8d891da-9843-4fb6-b22f-852aa692a862 created_at: type: string format: date-time example: 2020-08-13T13:16:21Z