getAverage (public)
- Maurice Fons (Unlicensed)
Description
getAvarage provides a rounded and an exact average for a selectable amount of time back from today.
Available for the following eKomi products
Professional light
Professional
Professional Plus light
Professional Plus
Premium
Premium Plus
Enterprise
Function Call
http://api.ekomi.de/v3/getAverage?auth=665|FMJuyuC8uEbo3WxRa5aG&type=serialized&days=365 |
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 | required |
type | Either json or serialized (default). Defines what output is being returned. | serialized | optional |
days | Number of days back from today which you want to retrieve orderIDs from Min: 1, Max 1095, Default: “” (=all) | INFO | optional |
POST-CONDITION | |
Parameter | Description |
|---|---|
number of ratings | How many ratings are part of this average rating |
exact_average | The result of the average rating calculation, rounded to twelve decimals |
rounded_average | the result of the average rating calculation, rounded to two decimals. |
seal | The type of seal awarded for the avarage rating. |
ERRORS | ||
CODE | Name | Description |
|---|---|---|
NonAuth | Missing auth parameter | |
NonFunction | Invalid function name for example ptOrder instead of putOrder | |
Access denied | Invalid auth value | |