getProductFeedback (public)
Description
getProductfeedback delivers the reviews for a product, including the rating and the text the clients sent.
Available for the following eKomi products
Professional Plus light
Professional Plus
Premium, Premium Plus
Enterprise
Function Call
https://api.ekomi.de/v3/getProductfeedback?auth=665|FMJuyuC8uEbo3WxRa5aG&version=cust-1.0.0&type=csv&charset=utf-8 |
Parameters :
PRE-CONDITION | |||
Parameter | Description | Example | mandatory |
auth | Interface-ID and Interface-Password, separated by pipe (|) | 665|FMJuyuC8uEbo3WxRa5aG | required |
interface_id | Can be used together with interface_pw instead of auth | 665 | optional |
interface_pw | Can be used together with interface_id instead of auth | FMJuyuC8uEbo3WxRa5aG | optional |
version | Script-Version. For self-build. Precede with ‘cust-’ | cust-1.0.0 | optional |
type | Output type. Either “csv” (default), “serialized” or “json” | csv | required |
product | By using the product parameter you can get feedback for one specific product. Value of this field must be alphanumeric and max. 32 chars and must be equal to a product_id you have stored in our API previously with putProduct. | acc14583 | optional |
charset | Character encoding. Either “iso” or “utf-8” (default). For non-ISO languages (Russian, Chinese, etc.) and for all JSON utf-8 must be used. | utf-8 | optional |
caching | You may use caching to obtain faster results. Possible values are: [none], [short], [middle] [long] and ([verylong]). Cachetime in seconds: none:0, short:120, middle:300, long:600, verylong:3600 | short | optional |
range | You may set a time range from which to request feedback: Possible values: [all], [1m], [3m], [6m], [1y] “m” indicates month(s) “y” indicates year [all] is the default | 6m | optional |
fields | allows you to specify which columns should be returned. Content of fields must be a comma-separated string (no spaces). You can also use this to sort the fields in a specific order. Any combination of the following fields is valid : [date] [order_id] [product_id] [rating] [feedback] [product_review_title]
[order_day] [firstname] [lastname] [screenname] [client_id] default : [date] [order_id] [product_id] [rating] [feedback] Please note that results are sorted by date, so leaving out [date] will affect the order of results as well as the range parameter. | date,feedback,rating | optional |
PRE-CONDITION | |
Parameter | Description |
submitted | UNIX timestamp of feedback |
order_id | Order/ transaction id of order |
product_id | Id of rated product |
rating | 1 to 5 stars |
review | Feedback text |
ERRORS | ||
CODE | Name | Description |
ERROR: | If the request is not valid the response will be Error: [error texts below]. | |
Interface ID or password not transmitted | ||
Interface ID or password is not valid. | ||
Type is not valid. Possible options: [csv], [json], [serialized]. | ||
Charset is not valid. Possible options: [iso] and ([utf-8]). | ||
Caching is not valid. Possible options: [none], [short], [middle], [long] and ([verylong]). | ||