Beex icon

Beex

Beex Contact Center API Interaction and Consumption

Report → Get Platform Detailed

AI-generated

Overview

This node interacts with the Beex Contact Center API to retrieve detailed platform time reports. It is useful for obtaining granular data about platform usage within a specified date range, which can help in analyzing operational performance and resource allocation in a contact center environment.

Use Case Examples

  1. A contact center manager wants to analyze detailed platform usage between two dates to optimize agent scheduling.
  2. A reporting system needs to fetch detailed platform time data for a specific campaign to generate performance dashboards.

Properties

Name Meaning
Start Date Start date for filtering the report data, formatted as YYYY-MM-DD.
End Date End date for filtering the report data, formatted as YYYY-MM-DD.
Return All Whether to return all results or only up to a given limit.
Limit The maximum number of records to return when Return All is false.
Offset The page number to retrieve, starting from 0, used for pagination.

Output

JSON

  • json - The detailed platform time report data returned from the Beex API.

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 that the start_date and end_date are provided in the correct format (YYYY-MM-DD).
  • API authentication errors may occur if the API key credential is missing or invalid. Verify the API key configuration in the node credentials.
  • Rate limiting or request throttling may happen; the node includes a delay between requests to mitigate this, but large data requests should be handled carefully.

Links

Discussion