Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Report → Get Managements per Hour

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve hourly classification information related to managements within a specified campaign portfolio. It is useful for analyzing the distribution and volume of management activities on an hourly basis, filtered by portfolio, date range, and optionally by user. For example, a call center manager can use this node to monitor agent performance and workload distribution throughout the day.

Use Case Examples

  1. Retrieve hourly management data for a specific campaign portfolio between two dates.
  2. Filter hourly management reports by user ID to analyze individual agent activity.

Properties

Name Meaning
Portfolio ID ID of the campaign portfolio to filter the report data.
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).
User ID Optional ID of the user to filter the report data by who logged the typing.
Return All Whether to return all results or only up to a given limit.
Limit Maximum number of results to return if Return All is false.
Offset Page number to retrieve, starting from 0, in descending order by creation date.

Output

JSON

  • json - Each item contains hourly management report data returned from the Beex API.

Dependencies

  • Beex Contact Center API with an API key credential

Troubleshooting

  • Common errors include invalid or missing parameters, which result in error messages from the Beex API. Ensure all required fields like Portfolio ID, Start Date, and End Date are correctly set.
  • 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 this, but ensure network connectivity and API availability.

Links

Discussion