Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Report → Get Strategies

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve strategy reports filtered by portfolio, strategy type, and date range. It is useful for analyzing different types of strategies such as Predictive, Progressive, SMS, and WhatsApp within a specified campaign portfolio over a given time period. For example, a user can fetch all predictive strategy data for a campaign between two dates to evaluate performance.

Use Case Examples

  1. Retrieve all predictive strategies for a specific campaign portfolio between January 1, 2024, and January 31, 2024.
  2. Fetch WhatsApp strategy reports for a campaign portfolio with pagination to limit the number of results.

Properties

Name Meaning
Portfolio ID ID of the campaign portfolio to filter the strategy report data.
Start Date Start date for filtering the strategy report data (format: YYYY-MM-DD).
End Date End date for filtering the strategy report data (format: YYYY-MM-DD).
Strategy Type Type of strategy to filter the report data. Options include Predictive (1), Progressive (2), SMS (3), and WhatsApp (5).
Return All Whether to return all results or limit the number of results returned.
Limit Number of results to return when Return All is false.
Offset Page number to retrieve, starting from 0, used for pagination.

Output

JSON

  • json - The JSON output contains the strategy report data retrieved from the Beex API, which may be an array of strategy objects or a single strategy object depending on the response.

Dependencies

  • Beex Contact Center API with an API key credential

Troubleshooting

  • Ensure the API key credential is correctly configured and has the necessary permissions to access the reports endpoint.
  • Verify that the Portfolio ID, Start Date, End Date, and Strategy Type parameters are correctly set and valid.
  • If receiving an error with status code and message 'Invalid or missing parameters', check that all required parameters are provided and formatted correctly.
  • Network or API downtime may cause request failures; retry after some time or check API status.

Links

Discussion