Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Report → Get Users Management

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve user management reports for a specified campaign portfolio, year, and month. It is useful for obtaining detailed user management data within a contact center environment, such as tracking user activities and performance metrics over a given time period. For example, a contact center manager can use this node to generate monthly user management reports filtered by campaign portfolio to analyze agent productivity.

Use Case Examples

  1. Retrieve user management report for portfolio ID '12345' for the year 2023 and month 04 to analyze agent performance.
  2. Generate monthly user management reports filtered by campaign portfolio to monitor user activities.

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.
Year Year in which the information will be retrieved, formatted as 'AAAA'.
Month Month in which the information will be filtered, formatted as 'MM'.

Output

JSON

  • json - The user management report data returned from the Beex API, typically an array of user management records.

Dependencies

  • Beex Contact Center API
  • API key credential for authentication

Troubleshooting

  • Ensure the API key credential is correctly configured and has the necessary permissions to access the reports endpoint.
  • Verify that the Portfolio ID, Year, and Month parameters are correctly provided and formatted as required.
  • Common error messages include HTTP status codes and messages indicating invalid or missing parameters; these can be resolved by checking the input parameters and API key validity.

Links

Discussion