Actions59
- Blacklist Actions
- Call Actions
- Client Actions
- Entity Actions
- Import Actions
- Lead Actions
- PBX Actions
- Queue Actions
- Report Actions
- Get Daily Managements
- Get Dropped Calls
- Get Summary
- Get Time Slot
- Get Users Management
- Get Calls
- Get Client Management
- Get Forms
- Get Incoming Call
- Get IVR Survey
- Get Log ACW
- Get Managements by ACW
- Get Managements per Hour
- Get Messaging Tickets
- Get PDP Control
- Get List PDP
- Get PDP Ranking
- Get Phones
- Get Platform Detailed
- Get Platform Summarized
- Get Product Managements
- Get Products
- Get Progress Managements
- Get Strategies
- Get Tickets Tracking
- Sequence Actions
- Template Actions
- Ticket Actions
- User Actions
Report → Get PDP Ranking
AI-generatedOverview
This node operation fetches the PDP (Payment Promises) Ranking report from the Beex Contact Center API. It allows users to retrieve ranking data filtered by campaign portfolio, date range, and ranking type (based on classification date or promise to pay date). This is useful for analyzing payment promise performance within a specified campaign and timeframe.
Use Case Examples
- A financial analyst wants to generate a report ranking customers based on their payment promises within a specific campaign between two dates.
- A collections manager needs to monitor the ranking of payment promises by classification date to prioritize follow-ups.
Properties
| Name | Meaning |
|---|---|
| Portfolio ID | ID of the campaign to filter the report, obtained from the Campaigns module on the platform. |
| Start Date | Start date for filtering the report data, in YYYY-MM-DD format. |
| End Date | End date for filtering the report data, in YYYY-MM-DD format. |
| Ranking Type | Type of report ranking, either based on classification date (MANAGEMENT_DATE) or payment promise date (PROMISE_DATE). |
| Return All | Whether to return all results or limit the number of results. |
| Limit | Number of results to return when Return All is false. |
| Offset | Page number to retrieve, starting from 0, for paginated results. |
Output
JSON
json- The JSON output contains the PDP ranking report data as returned by the Beex API. It includes ranking details filtered by the specified parameters.
Dependencies
- Beex Contact Center API with an API key credential
Troubleshooting
- Common errors include invalid or missing parameters, which result in error messages from the API. Ensure all required parameters (portfolio, start_date, end_date, type_ranking) are correctly set.
- API authentication errors may occur if the API key credential is missing or invalid. Verify the API key is correctly configured in the node credentials.
- Rate limiting or request throttling may happen due to the 1-second delay between requests implemented in the node. Adjust usage accordingly.
Links
- Beex API PDP Ranking Endpoint - Official API endpoint documentation for the PDP Ranking report.