Flowレポーティングは、リクエストされたデータを受け取るためのプログラマブルな方法を提供します。
概要
機器によって記録されたデータは、以下のような手順で収集することができる。
ステップ1：APIシークレットキーをFlowテクニカルチーム（support@flow-solutions.com）よりメールでリクエストして入手します。
ステップ2: 取得したAPIシークレットキーをX-Secret-Keyを使用してヘッダーに設定し、Flow Reportingシステム内での識別を確立します。
ステップ3: フローレポーティングシステムからより高速な応答を受信するために、ペイロードに必要なデータを提供します。
ステップ4： 「テスト」タブで提供されるテストスクリプトをリクエストに利用します。スクリプトをコピー、変更、実行し、機能を検証することができます。
リソース 回答の視覚化
FlowレポートAPIを通じて取得したデータをよりよく理解し、解釈するために、回答を調査し、可視化します。
プロのヒント
リクエストの理解
各APIレスポンスは、使用ステータスを識別するのに役立つ以下のヘッダーセットを返します：
Header | Description |
| Flowチームから取得したAPIキー |
| 応答メッセージの言語は、英語と日本語にのみ対応しています |
| application/jsonのみをサポートするコンテントタイプ。 |
401 応答
サーバーからのHTTP 401レスポンスは、期待されたとおりに正しく動作していないことを示し、その詳細を示すメッセージが表示されます。サポートが必要な場合はお問い合わせください。
200回答
サーバーからのHTTP 200レスポンスは、リクエストが正常に処理され、リクエスト送信者にデータが送信されたことを示します。
お問い合わせ
Email: support@flow-solutions.com
POST 当日、時間ごとのKPIを取得
https://reporting-api.flow-insight.com/rest/kpis/hourly
リクエスト:
date
APIリクエストのデータは(YYYY-MM-DD)形式となります。
storeCodes
APIリクエストされた店舗のデータ
＊1回のリクエストの上限は20店舗迄となります。
SAMPLE REQUEST
curl --location 'https://reporting-api.flow-insight.com/rest/kpis/hourly' \
--header 'Content-Type: application/json' \
--header 'X-Secret-Key: <Object Key from Flow / フローからのオブジェクトキー>' \
--header 'Accept-Language: ja' \
--data '{
"date": "2023-11-07",
"storeCodes": [
"001"
]
}'レスポンス反応:
返されるデータは、Flowウェブアプリで設定された営業時間に基づき、時間/入口別に表示されます。
データは来店客数・店間通行人数と属性値になります。POSシステムが統合されている場合、売上、取引件数、販売アイテムのデータも含まれます。
＊現行APIでは、日毎データは非対応となります。
＊現行APIでは、店舗総計の毎時データはは非対応となります。
＊現行APIでは、属性値は、各年代の推定実数値となります。
SAMPLE JSON RESPONSE
{
"data": [
{
"storeCode": "001",
"timestamp": "2024-01-16T12:00:00",
"traffic": {
"001": {
"enters": 0,
"exits": 0
},
"002": {
"enters": 61,
"exits": 44
},
"003": {
"enters": 35,
"exits": 34
}
},
"passersby": 408,
"demographics": {
"group_1": 10,
"group_2": 12,
"group_3": 10,
"group_4": 12,
"group_5": 12,
"group_6": 5,
"group_7": 12,
"group_8": 5
},
"sales": 10,
"transactions": 10,
"itemSold": 10
}
],
"status": 200
}ヘッダー
Content-Type: | application/json | |
X-Secret-Key: | <Object Key from Flow> | |
Accept-Language: | ja |
Body
{
"date": "2024-01-16",
"storeCodes": [
"001"
]
}