Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Report → Get Summary

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve a summary report related to customer service activities. It is designed to fetch summarized data filtered by a specific campaign (portfolio) and date. This node is useful for generating high-level insights and summaries of customer service performance on a given day, helping managers and analysts monitor key metrics and trends.

Use Case Examples

  1. A customer service manager wants to get a daily summary report for a specific campaign to review overall performance and identify areas for improvement.
  2. An analyst needs to extract summarized call center data for a particular date to include in a monthly report.

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.
Date Date of the call for which the summary report is requested, formatted as YYYY-MM-DD.

Output

JSON

  • json - The JSON output contains the summary report data retrieved from the Beex API for the specified portfolio and date.

Dependencies

  • Beex Contact Center API key credential required for authentication.

Troubleshooting

  • Common issues include invalid or missing parameters such as portfolio ID or date, which will result in API errors.
  • API request failures due to network issues or invalid API key will throw errors with messages indicating the problem.
  • Ensure the date is formatted correctly as YYYY-MM-DD and the portfolio ID corresponds to an existing campaign on the platform.

Links

Discussion