Download OpenAPI specification:
The PX Insights API allows external systems to push customer insights — such as product reviews and search terms — into the Akeneo Product Experience Management (PXM) platform.
These insights are then made available within the Akeneo PIM, where they can be leveraged by product teams to better understand customer behavior, improve product content, and enrich the product experience.
All incoming data is processed and linked to products via UUIDs, product model codes, or reconciliation mechanisms. An asynchronous ingestion endpoint is available.
Ingest both consolidated and review data
If the product identification contains valid product UUID or product model code the data will be linked to the corresponding product. Otherwise the metadata field is used to identify the product using the ID reconciliation mechanism.
Follows an "Upsert" behavior: only new data is created, the rest is updated. Nothing is ever deleted
This endpoint pushes the insights to a queue and returns immediately with a 202 status code. It removes the burden of handling timeouts, retries, and rate limits from the client.
| X-PIM-TOKEN required | string PIM API token used for authentication |
| X-PIM-URL required | string <uri> Base URL of the PIM instance (e.g. https://my-pim.cloud.akeneo.com) |
| X-PIM-CLIENT-ID required | string Client ID used coming from the PIM |
| sync_id | string <uuid> Unique identifier for the synchronization operation |
| origin | string The origin of the data (platform where the reviews are coming from) |
object (ConsolidatedReview) represents all the review data for a product or a product model coming from a unique origin |
{- "sync_id": "1a2b6453-45d0-4892-b3f6-836c2d2be758",
- "origin": "Yotpo",
- "review": {
- "uuid": "1a2b6453-45d0-4892-b3f6-836c2d2be758",
- "product_identification": {
- "product_type": "product",
- "product_model_code": "my-test-product-model-code",
- "product_uuid": "1a2b6453-45d0-4892-b3f6-836c2d2be758",
- "origin": "Yotpo",
- "metadata": {
- "sku": "my-test-sku"
}
}, - "sync_date": "2024-11-06T13:54:47.928493158Z",
- "average_score": 4.5,
- "maximum_score": 5,
- "count": 10,
- "breakdown": {
- "1": 3,
- "2": 4,
- "3": 3,
- "4": 5,
- "5": 5
}, - "raw_reviews": [
- {
- "origin": "Yotpo",
- "external_id": "1a2b6453-45d0-4892-b3f6-836c2d2be758",
- "sync_date": "2024-11-06T13:54:47.928493158Z",
- "score": 5,
- "title": "Best phone I've ever owned!!!",
- "text": "This smartphone is fast, sleek, and takes amazing photos.",
- "review_date": "2024-11-06T13:54:47.928493158Z",
- "up_votes": 0,
- "down_votes": 0,
- "incentivized": false,
- "total_comments_count": 0,
- "moderated_status": "approved",
- "is_syndicated": false,
- "positive_sentiment_themes": [
- "quality",
- "performance"
], - "negative_sentiment_themes": [
- "price"
]
}
]
}
}"reviews received for processing"Ingests review data for a product or product model. This endpoint is intended only for testing purposes.
Product identification is determined in the following order:
metadata field is used to identify the product via the ID reconciliation mechanism.This operation follows an upsert pattern:
The request is processed synchronously, and a response is returned immediately.
| X-PIM-TOKEN required | string PIM API token used for authentication |
| X-PIM-URL required | string <uri> Base URL of the PIM instance (e.g. https://my-pim.cloud.akeneo.com) |
| X-PIM-CLIENT-ID required | string Client ID used coming from the PIM |
| uuid | string <uuid> Unique identifier for the consolidated review |
required | object (ProductIdentification) |
| sync_date | string <date-time> Date of the synchronization |
| average_score | number <float> [ 0 .. 5 ] Average review score (0-5) |
| maximum_score | integer [ 0 .. 5 ] Maximum possible score (typically 5) |
| count | integer >= 0 Total number of reviews |
object or null (breakdown) Number of review for each score between 1 and 5. | |
Array of objects (RawReview) |
{- "uuid": "1a2b6453-45d0-4892-b3f6-836c2d2be758",
- "product_identification": {
- "product_type": "product",
- "product_model_code": "my-test-product-model-code",
- "product_uuid": "1a2b6453-45d0-4892-b3f6-836c2d2be758",
- "origin": "Yotpo",
- "metadata": {
- "sku": "my-test-sku"
}
}, - "sync_date": "2024-11-06T13:54:47.928493158Z",
- "average_score": 4.5,
- "maximum_score": 5,
- "count": 10,
- "breakdown": {
- "1": 3,
- "2": 4,
- "3": 3,
- "4": 5,
- "5": 5
}, - "raw_reviews": [
- {
- "origin": "Yotpo",
- "external_id": "1a2b6453-45d0-4892-b3f6-836c2d2be758",
- "sync_date": "2024-11-06T13:54:47.928493158Z",
- "score": 5,
- "title": "Best phone I've ever owned!!!",
- "text": "This smartphone is fast, sleek, and takes amazing photos.",
- "review_date": "2024-11-06T13:54:47.928493158Z",
- "up_votes": 0,
- "down_votes": 0,
- "incentivized": false,
- "total_comments_count": 0,
- "moderated_status": "approved",
- "is_syndicated": false,
- "positive_sentiment_themes": [
- "quality",
- "performance"
], - "negative_sentiment_themes": [
- "price"
]
}
]
}{- "uuid": "1a2b6453-45d0-4892-b3f6-836c2d2be758",
- "product_identification": {
- "product_type": "product",
- "product_model_code": "my-test-product-model-code",
- "product_uuid": "1a2b6453-45d0-4892-b3f6-836c2d2be758",
- "origin": "Yotpo",
- "metadata": {
- "sku": "my-test-sku"
}
}, - "sync_date": "2024-11-06T13:54:47.928493158Z",
- "average_score": 4.5,
- "maximum_score": 5,
- "count": 10,
- "breakdown": {
- "1": 3,
- "2": 4,
- "3": 3,
- "4": 5,
- "5": 5
}, - "raw_reviews": [
- {
- "origin": "Yotpo",
- "external_id": "1a2b6453-45d0-4892-b3f6-836c2d2be758",
- "sync_date": "2024-11-06T13:54:47.928493158Z",
- "score": 5,
- "title": "Best phone I've ever owned!!!",
- "text": "This smartphone is fast, sleek, and takes amazing photos.",
- "review_date": "2024-11-06T13:54:47.928493158Z",
- "up_votes": 0,
- "down_votes": 0,
- "incentivized": false,
- "total_comments_count": 0,
- "moderated_status": "approved",
- "is_syndicated": false,
- "positive_sentiment_themes": [
- "quality",
- "performance"
], - "negative_sentiment_themes": [
- "price"
]
}
]
}