CUcubesoftware
ChatSessions

List Chat Sessions

Changed on

List chat sessions for the current user

get/agents/chat/sessions

Request

  • Base URL
    https://api.cubesoftware.com
  • Auth
    OAuth 2
    Authorization code: https://portal.cubesoftware.com/o/authorize/
    Token URL: https://api.cubesoftware.com/o/token/

Query parameters

data_table_idstring

When listing sessions with session_type=DATA_TABLE_MANAGEMENT, filter to sessions scoped to this source data table UUID.

limitinteger

Number of items per page (default: 50)

pageinteger

Page number (default: 1)

session_typestring

Filter by session type (default: CHAT). One of: CHAT, PLANNER, DATA_TABLE_MANAGEMENT, WIDGET_BUILDER

Response

idstring required
created_atstring date-time required
last_active_atstring date-time required
app_type'SLACK' | 'MS_TEAMS' | 'CUBE_API' required
  • SLACK - Slack
  • MS_TEAMS - Microsoft Teams
  • CUBE_API - Cube API
namestring nullable
session_type'CHAT' | 'WIDGET_BUILDER' | 'PLANNER' | 'DATA_TABLE_MANAGEMENT'
  • CHAT - Chat
  • WIDGET_BUILDER - Widget Builder
  • PLANNER - Planner
  • DATA_TABLE_MANAGEMENT - Data Table Management
contextunknown
resourcesstring required

Changes