PX Insights
#Key Platform Behaviors
#Asynchronous Processing
The PX Insights API processes reviews asynchronously. When you submit reviews to the /api/v1/reviews/ingest/async
endpoint, it is placed in a processing queue. This approach offers several benefits:
- Improved reliability: Requests return quickly without waiting for review processing to complete.
- Enhanced scalability: The system handles large volumes of reviews without performance degradation.
- Simplified client logic: You don’t need to implement complex retry or timeout handling in your client application.
For development and troubleshooting purposes, a synchronous endpoint is also available at /api/v1/reviews/ingest
. This endpoint processes reviews immediately and returns results in the response.
It is intended only for non-production use, such as debugging.
Please note that rate limits for this endpoint are much more restrictive, and using it in production environments is not supported.
#Error Handling, Retries, and Rate Limiting
The PX Insights API intelligently manages errors, retries, and rate limiting to ensure reliable operation:
#Automatic Error Handling and Retries
When reviews are submitted:
- The API acknowledges receipt of the data immediately.
- If errors occur during processing, the system retries automatically using intelligent backoff strategies.
- Permanent failures are logged and made available for review by administrators.
#PIM Rate Limiting Management
PX Insights includes built-in logic to handle rate limits when interacting with your Akeneo PIM:
- Automatic throttling: The system respects your PIM’s API rate limits and adjusts request frequency accordingly.
- Queue prioritization: During high-load periods, requests are queued and prioritized based on system conditions.
- Back-pressure handling: If the PIM API becomes unavailable or overloaded, PX Insights reduces throughput and retries later.
- Automatic recovery: Once rate limits reset or the PIM becomes responsive again, processing resumes automatically — no action required on your side.
These mechanisms ensure stability and performance, even under heavy load, without requiring additional logic in your integration.
#ID Reconciliation
PX Insights uses a flexible and reliable ID reconciliation system to associate each review with the correct product in your PIM.
- Direct product identification: If your request includes
product_type
and eitherproduct_uuid
orproduct_model_code
, PX Insights uses these for direct mapping. - Metadata-based matching: If direct identifiers are missing, PX Insights uses the
metadata
object — typically thesku
— to find the matching product. - Flexible mapping logic: Additional metadata fields can be leveraged to improve matching accuracy where needed.
To maximize reconciliation success, always include at least one reliable identifier — preferably the sku
— in the metadata
object of your request.