Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Report → Get Forms

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve forms report data filtered by portfolio ID, start date, end date, and form ID. It is useful for obtaining detailed information about form submissions within a specified campaign and date range, enabling analysis of form-related customer interactions.

Use Case Examples

  1. Retrieve all form submissions for a specific campaign between two dates.
  2. Get a limited number of form report entries for a given form ID within a portfolio.

Properties

Name Meaning
Portfolio ID ID of the campaign in which the information will be filtered, obtained from the ID column in the Campaigns module on the platform.
Start Date Start date for filtering the report data. Format: YYYY-MM-DD.
End Date End date for filtering the report data. Format: YYYY-MM-DD.
ID Form ID of the form to filter the information.
Return All Whether to return all results or only up to a given limit.
Limit Size of the page you want to obtain. From 1 to XX.
Offset Page number you wish to obtain. In descending order to the creation date and starting from 0.

Output

JSON

  • json - The JSON output contains the forms report data retrieved from the Beex API, filtered according to the input parameters.

Dependencies

  • Beex Contact Center API with an API key credential

Troubleshooting

  • Common issues include invalid or missing parameters resulting in API errors. Ensure all required fields such as Portfolio ID, Start Date, End Date, and Form ID are correctly provided.
  • API authentication errors may occur if the API key credential is missing or invalid. Verify the API key is correctly configured in the node credentials.
  • Rate limiting or network errors may cause request failures. The node includes a delay between requests to mitigate rate limits, but network stability should be checked if errors persist.

Discussion