WTS Chat icon

WTS Chat

Get data from Wts API

Actions17

Overview

The "Get All Sessions" operation of the WTS Chat node fetches a paginated list of chat sessions from the Helena API. It allows filtering and sorting sessions based on various criteria such as creation date, update date, activity period, end time, status, tags, channels, departments, users, and associated contacts. Additionally, it supports including detailed information about agents, channels, classifications, contacts, and departments related to each session.

This operation is useful in scenarios where you want to monitor or analyze chat sessions, generate reports, or integrate session data into other workflows. For example, a customer support manager could use this node to retrieve all active sessions within a specific department and export them for performance analysis.

Properties

Name Meaning
Page Number The page number of results to retrieve (pagination). Default is 1.
Page Size The number of sessions per page to return. Must be between 1 and 100. Default is 10.
Order By Field name by which to sort the sessions.
Order Direction Direction of sorting: Ascending or Descending. Default is Ascending.
Tag Names or IDs Filter sessions by one or more tag names or IDs. You can select from a list or specify IDs via expressions.
CreatedAt.After Filter sessions created after this date/time (format: YYYY-MM-DD hh:mm, timezone-aware).
CreatedAt.Before Filter sessions created before this date/time.
UpdatedAt.After Filter sessions updated after this date/time.
UpdatedAt.Before Filter sessions updated before this date/time.
ActiveAt.After Filter sessions that were active after this date/time.
ActiveAt.Before Filter sessions that were active before this date/time.
EndAt.After Filter sessions that ended after this date/time.
EndAt.Before Filter sessions that ended before this date/time.
Status Session Filter sessions by their status. Possible values: Completed, Hidden, In Progress, Pending, Started, Undefined.
Departments Name or ID Filter sessions by department. Choose from a list or specify an ID via expression.
Channel Names or IDs Filter sessions by one or more channel names or IDs. Select from a list or specify IDs via expression.
User Name or ID Filter sessions by user. Choose from a list or specify an ID via expression.
Contact ID Filter sessions by contact ID.
Include Details Specify additional details to include in the response. Options include AgentDetails, ChannelDetails, ChannelTypeDetails, ClassificationDetails, ContactDetails, DepartmentsDetails, Undefined.

Output

The output is an array of JSON objects, each representing a session matching the specified filters and pagination. Each session object contains session-related fields as returned by the Helena API, potentially including:

  • Basic session metadata (IDs, timestamps, status)
  • Associated tags, channels, departments, users, and contacts
  • Additional details if requested via the "Include Details" property, such as agent info, channel types, classification, etc.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authentication with the Helena API.
  • Makes HTTP GET requests to the endpoint https://api-test.helena.run/chat/v1/session.
  • Uses query parameters to pass filters, pagination, sorting, and detail inclusion options.

Troubleshooting

  • Empty Results: If no sessions are returned, verify that your filter criteria (dates, tags, statuses, etc.) match existing sessions. Also check pagination settings.
  • Authentication Errors: Ensure the API key credential is correctly configured and valid.
  • Invalid Date Formats: Date/time filters must be in the format YYYY-MM-DD hh:mm and respect your timezone.
  • API Rate Limits or Network Issues: Temporary failures may occur; retry or check network connectivity.
  • Incorrect Option Usage: Make sure multi-select properties like tags, statuses, channels, and include details are properly set as arrays.

Links and References

Discussion