List chat events from a specific chat_group | Hume API

Authentication

X-Hume-Api-Key
API Key authentication via header

Path parameters

id
string
Required
format: "uuid"
Identifier for a Chat Group. Formatted as a UUID.

Query parameters

page_size
integer
Optional
Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
For example, if page_size is set to 10, each page will include up to 10 items. Defaults to 10.

page_number
integer
Optional
Defaults to 0
Specifies the page number to retrieve, enabling pagination.
This parameter uses zero-based indexing. For example, setting page_number to 0 retrieves the first page of results (items 0-9 if page_size is 10), setting page_number to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.

ascending_order
boolean
Optional
Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true.

Response

Success

events_page
list of objects
List of Chat Events for the specified page_number and page_size.

Show 9 properties

• id
  string
  Identifier for the Chat Group. Any Chat resumed from this Chat Group will have the same chat_group_id. Formatted as a UUID.

• page_number
  integer
  The page number of the returned list.
  This value corresponds to the page_number parameter specified in the request. Pagination uses zero-based indexing.

• page_size
  integer
  The maximum number of items returned per page.
  This value corresponds to the page_size parameter specified in the request.

• pagination_direction
  enum
  Allowed values: ASC, DESC

• total_pages
  integer
  The total number of pages in the collection.