====== Dashboard API ======

Host: **sg02.picalike.copex-kunden.de**

Port: **9091**


===== Dependencies =====



===== git =====

Im git zu finden als:

<code>
$ git clone ssh://picalike@dev01.picalike.corpex-kunden.de/home/picalike/stephan/git/dashboard_api
</code>

===== Allgemeines =====

Anfragen mit json als post

Antworten:


  * als json
  * immer “message” <str> und “result” <int>
  * negativer “result” bedeutet Error
  * positiver “result” ist Grund zur Hoffnung
  * in “response” steht die Antwort auf die Frage


===== APIs =====



==== /get_number_of_requests ====

Returns number of requests for looks or similarity within last second or within a given time interval (by resolution second, minute, hour).

**in:**

time_type: last_second

<code>
{"userid": <str>, "time_type": "last_second", "information_type": <str> (sim, look)}
</code>
time_type: interval

<code>
{"userid": <str>, "time_type": "interval", "from_time": <str>, "to_time": <str>, "information_type": <str> (sim, look), "resolution": <str> (second, minute, hour)}
</code>
Dabei sind “from_time” und “to_time” im Format: “2017-02-20 16:18:31”. Die Bedingung an das Feld date in der Datenbank ist: to_time > date >= from_time.

**out:**

<code>
{"result": 1, "message": <str>, "response": {"count": <int>}}
</code>

==== /get_number_of_requests_by_country ====

Returns number of requests aggregated by country_code for looks or similarity within last second or within a given time interval (by resolution second, minute, hour). The value of the field “response” is a dictionary with keys country_code and values the number of requests.

**in:**

time_type: last_second

<code>
{"userid": <str>, "time_type": "last_second", "information_type": <str> (sim, look)}
</code>
time_type: interval

<code>
{"userid": <str>, "time_type": "interval", "from_time": <str>, "to_time": <str>, "information_type": <str> (sim, look), "resolution": <str> (second, minute, hour)}
</code>
Dabei sind “from_time” und “to_time” im Format: “2017-02-20 16:18:31”. Die Bedingung an das Feld date in der Datenbank ist: to_time > date >= from_time.

**out:**

<code>
{"result": 1, "message": <str>, "response": {"country_code"<str>: "count"<int>}}
</code>

==== /get_last_product_ids ====

Returns last #limit product ids (that were recorded).

**in:**

<code>
{"userid": <str>, "limit": <int>}
</code>
**out:**

<code>
{"result": 1, "message": <str>, "response": [{"shop_apikey": <str>, "product_id": <int>}, ...]}}}
</code>

==== /all_countries ====

Liste aller Länder (aus der country_mapping.json Datei).

**in:**

<code>
{"userid": <str>}
</code>
**out:**

<code>
{"result": 1, "message": <str>, "response": ["country"<str>, ...]}
</code>