Fetches a paginated list of Chat events.

Authentication

• X-Hume-Api-Key: string
  API Key authentication via header

Path parameters

• id: string
  Required format: "uuid"
  Identifier for a Chat. 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

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

• events_page: list of objects

  • id: string
    Identifier for a Chat. Formatted as a UUID.
  • page_number: integer
    The page number of the returned list.
  • page_size: integer
    The maximum number of items returned per page.
  • pagination_direction: enum
    Allowed values: ASC, DESC
  • start_timestamp: long
    Time at which the Chat started. Measured in seconds since the Unix epoch.
  • status: enum
    Show 6 enum values
  • total_pages: integer
    The total number of pages in the collection.
  • config: object
    • end_timestamp: long or null
      Time at which the Chat ended. Measured in seconds since the Unix epoch.
    • metadata: string or null
      Stringified JSON with additional metadata about the chat.