Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Report → Get Progress Managements

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve progress management reports filtered by campaign portfolio and date range. It is useful for monitoring the progress of management activities within a specified campaign over a given period. For example, a user can obtain detailed progress reports for a marketing campaign between two dates to analyze performance and management effectiveness.

Use Case Examples

  1. Retrieve progress management data for a specific campaign portfolio between a start and end date to evaluate management progress.
  2. Use the node to generate reports on management progress for different campaigns to compare their effectiveness over time.

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.

Output

JSON

  • json - The JSON output contains the progress management report data retrieved from the Beex API, structured as an array of objects representing the report entries.

Dependencies

  • Beex Contact Center API with an API key credential for authentication.

Troubleshooting

  • Common issues include invalid or missing parameters resulting in API errors. The node throws errors with messages indicating the HTTP status code and error details from the Beex API response.
  • Ensure the API key credential is correctly configured and has the necessary permissions to access the reports endpoint.
  • Verify that the Portfolio ID and date parameters are correctly formatted and valid to avoid request failures.

Discussion