Get product performance
Reviews received and published, average rating, questions and sentiment score, from Reviews > Performance.
GET https://cotlet.dev/api/v1/okendo/product-performance
read
Reads the Products tab of Reviews > Performance. It returns reviews received (published and unpublished), reviews published with their share of those received, the average rating across both, questions received and the sentiment score, for all products or the ones you name, with a series for the group_by step. The agent can compare two periods by calling it twice.
Parameters
| Name | Type | Description |
|---|---|---|
| range enum | enum | Last 4 weeks, Last 30 days, Last 12 weeks, Last 90 days, Past year or All time. |
| group_by enum | enum | Day, Week, Month, Quarter or Year. The steps that fit depend on the range. |
| product string | string | A product or product group. Default: all products. |
Request
curl https://cotlet.dev/api/v1/okendo/product-performance \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("okendo", "get_product_performance")const result = await cotlet.call('okendo', 'get_product_performance');cotlet call okendo get_product_performanceExample response
{
"range": "Last 4 weeks",
"group_by": "Week",
"reviews_received": 120,
"reviews_published": 108,
"published_share": "90%",
"average_rating": 4.6,
"questions_received": 14,
"sentiment_score": 0.72,
"series": [
{
"week": "Sep 28",
"reviews_received": 31
},
{
"week": "Oct 5",
"reviews_received": 29
},
{
"week": "Oct 12",
"reviews_received": 34
},
{
"week": "Oct 19",
"reviews_received": 26
}
]
}