Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Report → Get Products

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve product reports filtered by a specified campaign portfolio. It is useful for obtaining detailed product-related data within a campaign, such as sales or management reports, which can help in analyzing product performance and making informed business decisions.

Use Case Examples

  1. Retrieve a list of products associated with a specific campaign portfolio to analyze sales data.
  2. Fetch product reports filtered by campaign ID to monitor product management 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.
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.
Offset Page number you wish to obtain. In descending order to the creation date and starting from 0.

Output

JSON

  • json - The JSON output contains the product report data retrieved from the Beex API, filtered by the specified portfolio and pagination parameters.

Dependencies

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

Troubleshooting

  • Common issues include invalid or missing API key credentials, incorrect portfolio ID, or network connectivity problems.
  • Error messages typically include HTTP status codes and descriptive messages from the Beex API, such as 'Invalid or missing parameters'. Ensure all required parameters are correctly set and the API key is valid.

Links

Discussion