API REFERENCE
Product Reviews API
GET
/v1/product/comment-analysis-listFree·api.etshop.ai/open-apiCredits usage rules
Billing: shop/product lists and top sellers cost 1 Credit per returned record; shop details cost 2 Credits per call. Details, trends, daily data and reviews are free (the record must have been returned by a list or details call within 3 days). Keyword search costs 1 Keyword Credit per keyword, and the same keyword is free for 30 days. Shop monitoring costs 1 Monitor Credit per shop for 30 days and is not refunded when stopped. Empty results are free and server errors are refunded automatically.
Request headers
AUTHORIZATION
Authorization: {API Key}CONTENT-TYPE
application/jsonACCEPT
application/jsonRequest example
cURL
curl --location --request GET 'https://api.etshop.ai/open-api/v1/product/comment-analysis-list?product_id=1284567890&with_photo=1&order_by=date&direction=desc¤t_page=1&page_size=2' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' Request parameters
Pass each parameter in its specified location.
| Parameter | Type | Description |
|---|---|---|
| product_id
query · required
| integer | Product ID |
| review_star
query · optional
| integer | Filter by rating (rounded down). Valid options: 5, 4, 3, 2, 1. |
| sku
query · optional
| integer | SKU image ID. Only reviews for purchases of this variation are returned. |
| with_photo
query · optional
| integer | Pass 1 to return only reviews with buyer photos; 0 for no restriction. |
| current_page
query · optional
| integer | Page number (min: 1, default: 1). |
| page_size
query · optional
| integer | Items per page (range: 1-100, default: 20). |
| order_by
query · optional
| string | Sort field. Valid options: date (review time), rating (rating). If omitted, the most recently collected reviews come first. |
| direction
query · optional
| string | Sort direction. Valid options: desc (descending, default), asc (ascending). |
Response example
Response · JSON
{
"code": 200,
"message": "success",
"data": {
"data": [
{
"id": 58420917,
"img_url": "https://i.etsystatic.com/iap/8d2c41/6345678901/iap_fullxfull.6345678901_m4n7q2rs.jpg?version=0",
"date": 1794021600,
"buyer_real_name": "Emily Carter",
"buyer_avatar_url": "https://i.etsystatic.com/iusa/2b7e19/104582736/iusa_75x75.104582736_3kfz.jpg?version=0",
"rating": 5,
"review": "Beautiful, soft linen and the color is exactly as pictured. Shipping to the US took just over a week."
},
{
"id": 58377205,
"img_url": "https://i.etsystatic.com/iap/51f0b3/6334567890/iap_fullxfull.6334567890_h8w1x5te.jpg?version=0",
"date": 1793761200,
"buyer_real_name": "Sophie",
"buyer_avatar_url": "https://www.etsy.com/images/avatars/default_avatar_75x75.png",
"rating": 4,
"review": "Lovely quality. It wrinkles a lot, but that is expected with linen."
}
],
"page": {
"page_count": 156,
"current_page": 1,
"total_count": 312,
"page_size": 2
}
},
"credits": {
"type": "default",
"remaining_credits": 196531,
"consumed_credits": 0,
"total_credits": 196531
}
}
Example data from the existing documentation
Response structure
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
| » code | integer | true | none | Status Code |
| » message | string | true | none | Response message |
| » data | object | true | none | Response data |
| »» data | [object] | true | none | Review list |
| »»» id | integer | true | none | Review ID |
| »»» rating | number | true | none | Rating (1–5; a few reviews may have a decimal rating) |
| »»» review | string | true | none | Review text |
| »»» date | integer | true | none | Review time (Unix timestamp, seconds) |
| »»» img_url | string | true | none | Buyer photo URL; empty string if there is none |
| »»» buyer_real_name | string | true | none | Buyer name |
| »»» buyer_avatar_url | string | true | none | Buyer avatar URL |
| »» page | object | true | none | Pagination |
| »»» page_count | integer | true | none | Total pages |
| »»» current_page | integer | true | none | Current page number |
| »»» total_count | integer | true | none | Total records |
| »»» page_size | integer | true | none | Items per page |
| » credits | object | true | none | Credits information of this request. See Billing Rules. |
| »» type | string | true | none | Credits type. default for this endpoint. |
| »» remaining_credits | integer | true | none | Remaining Credits after this request |
| »» consumed_credits | integer | true | none | Credits consumed by this request (0 for this endpoint) |
| »» total_credits | integer | true | none | Credits balance before this request (remaining_credits + consumed_credits) |
