Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Report → Get Client Management

AI-generated

Overview

This node interacts with the Beex Contact Center API to obtain client management reports filtered by campaign portfolio and date range. It is useful for retrieving classification information by client within a specified campaign and time period, enabling detailed analysis of client interactions and management activities.

Use Case Examples

  1. Retrieve client management report for a specific campaign portfolio between two dates to analyze client classification and management trends.
  2. Use the node to fetch paginated client management data with options to limit the number of results or return all data.

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.
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. Only used if Return All is false.
Offset Page number you wish to obtain. In descending order to the creation date and starting from 0.

Output

JSON

  • json - Client management report data returned from the Beex API, containing classification information by client filtered by portfolio and date range.

Dependencies

  • Beex Contact Center API with an API key credential

Troubleshooting

  • Ensure the API key credential is correctly configured and has the necessary permissions to access the reports endpoint.
  • Verify that the Portfolio ID, Start Date, and End Date parameters are correctly set and formatted as YYYY-MM-DD.
  • If the API returns an error, check the error message for details such as invalid or missing parameters and adjust the input accordingly.
  • Be mindful of API rate limits; the node includes a delay between requests to avoid hitting rate limits.

Links

Discussion