Fineguide icon

Fineguide

Interact with Fineguide REST API v1

Actions13

Session → Get All

AI-generated

Summary

Retrieve a list of chat sessions for a specified bot, optionally filtered by human escalation status and creation date range, with a limit on the number of sessions returned.

Inputs

  • Bot ID (required) — The ID of the bot for which to retrieve sessions.
  • Human Escalated — Filter sessions by escalation status: all, only escalated, or only non-escalated sessions.
  • Date From — Return sessions created after this date/time.
  • Date To — Return sessions created before this date/time.
  • Limit — Maximum number of sessions to return (1-100). Defaults to 50.

Output shape

a list of session objects returned as JSON.

The returned sessions may be filtered by the optional parameters. The 'limit' parameter restricts the number of sessions returned to a maximum of 100. If an error occurs and 'Continue On Fail' is enabled, error details are included per item; otherwise, the node fails.

Examples

Example 1: Retrieve up to 30 sessions for bot with ID 'bot123' created after January 1, 2024, which are escalated to human agents.

Set 'Bot ID' to 'bot123', 'Human Escalated' to 'Escalated Only', 'Date From' to '2024-01-01T00:00:00.000Z', and 'Limit' to 30.

Discussion