Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
https://api.ekomi.de/v3/getFeedback?auth=665INTERFACE_ID|FMJuyuC8uEbo3WxRa5aGPASSWORD&version=cust-1.0.0&type=csv&charset=utf-8

...

PRE-CONDITIONS

Parameter

Description

Example

mandatory

auth

Interface-ID and Interface-Password, separated by pipe (|)

665ABC|FMJuyuC8uEbo3WxRa5aGXYZ

required

interface_id

Can be used together with interface_pw instead of auth

665ABC

optional

interface_pw

Can be used together with interface_id instead of auth

FMJuyuC8uEbo3WxRa5aGXYZ

optional

version

Script-Version. For self-build. Precede with ‘cust-’

cust-1.0.0

required

type

Output type. Either “csv” (default) or “json”

csv

optional

charset

Character encoding. Either “iso” (default) or “utf-8”. For non-ISO languages (Russian, Chinese, etc.) and for all JSON utf-8 must be used.

utf-8

optional

filter

Here you can filter for [all], [positive] and [critical] reviews.

[all] is the default.

[critical] will return reviews with less than 4 stars

[positive] will return reviews with more than 3 stars

all

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] [rating] [feedback] [comment] [shop_review_title] [has_email]

additional fields for AFNOR compliance :

[order_day] [firstname] [lastname] [screenname] [client_id]

default :

[date] [order_id] [rating] [feedback] [comment]

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

...