company logo

ヘルプセンター

Flow Solutionsへ
Flowプラットフォーム株式会社Flow Solutionsプライバシーポリシー
すべてのコレクション計測機器・データ連携Flow API ドキュメンテーション

Flow API ドキュメンテーション

Connecting your systems with your in-store analytics data via the Flow API

Flow Reporting API 連携ガイド

1. 概要

本ガイドは、Flow Reporting APIを利用して店舗データを取得する方法を説明します。

本APIでは以下のデータを取得できます:

  • 来店数(入口別)

  • 属性情報(年代・性別)

  • 売上

  • 取引数

  • 販売点数

本APIのデータは、Flowプラットフォーム上と同一のロジックに基づいており、レポーティング用途としてそのまま利用可能です。

2. 利用可能API

現在利用可能なエンドポイント:/kpis/hourly
時間別の来店数・属性・売上データを取得します。

今後、同一仕様に基づくAPIが追加される可能性があります。
データ構造の変更や新規APIをご希望の場合は、以下までご連絡ください:
[email protected]

3. クイックスタート

データ取得手順:

  1. APIキー取得
    https://app.flow-insight.com/general
    設定 > 全般 > システム連携 > Flow API

  2. 店舗コード取得
    Flowより提供

  3. リクエスト送信
    POST
    https://reporting-api.flow-insight.com/rest/kpis/hourly

  4. レスポンス取得およびデータ処理

以上で基本的なデータ連携が可能です。

4. 認証

ヘッダー設定:

Content-Type: application/json  
X-Secret-Key: {APIキー}  
Accept-Language: ja  

5. リクエスト仕様

cURL例

curl -X POST https://reporting-api.flow-insight.com/rest/kpis/hourly \
-H "Content-Type: application/json" \
-H "X-Secret-Key: {APIキー}" \
-H "Accept-Language: ja" \
-d '{
  "date": "2026-04-19",
  "storeCodes": ["101", "102"]
}'

6. レスポンス仕様

サンプル

{
  "data": [
    {
      "storeCode": "101",
      "timestamp": "2026-04-19T11:00:00",
      "traffic": {
        "001": { "enters": 37, "exits": 47 }
      },
      "demographics": {
        "group_2": 11,
        "group_6": 50
      },
      "sales": 51854,
      "transactions": 12,
      "itemSold": 22
    }
  ],
  "status": 200
}

7. データ項目説明

フィールド

説明

storeCode

Flowが管理する店舗の一意ID

timestamp

対象時間帯の開始時刻(例:11:00:00 → 11:00〜11:59のデータ)

traffic

入口またはセンサー単位の来店・退店数

  • enters:入店数

  • exits:退店数

※「001」「002」などのキーは各入口・センサーの識別子です(Flow側で管理しており、店舗側で名称を把握していない場合があります)。

重要:店舗全体の来店数を確認する場合は、すべての入口(キー)のenters値を合計してください。

demographics

年代・性別別の推定人数

  • group_1:男性 18歳以下

  • group_2:男性 19〜44歳

  • group_3:男性 45〜59歳

  • group_4:男性 60歳以上

  • group_5:女性 18歳以下

  • group_6:女性 19〜44歳

  • group_7:女性 45〜59歳

  • group_8:女性 60歳以上

※値が0または未検出の場合、省略されることがあります。

sales

売上金額

transactions

取引件数

itemSold

販売点数

8. 店舗コード

店舗コードはFlowが管理する一意の識別子です。
お客様側で変更・新規作成はできません。

各店舗に割り当てられているFlowプラットフォーム上の店舗IDと一致します。

9. データ取得ルール

  • 1回のリクエストで最大20店舗まで指定可能

  • 20店舗を超える場合は複数リクエストに分割

制限事項:

  • 「*」による全店舗取得はできません

  • 店舗コードは必ず個別に指定する必要があります

10. データ更新

  • データは店舗稼働中に随時更新されます

  • 最新時間帯のデータは変動する可能性があります

  • 確定値として利用する場合は営業終了後のデータをご利用ください

  • 過去データはすべてAPI経由で取得可能です

11. データ集計と利用方法

本APIは時間別データを提供します。

  • 日次データ:時間別データの合計

  • 月次データ:日次データの合計

集計処理は利用者側で実施します。

利用用途

時間別データの主な用途:

  • 時間帯別のパフォーマンス分析

  • ピーク時間の把握

  • スタッフ配置の最適化

日次データの主な用途:

  • レポーティングおよびKPI管理

  • パフォーマンスの集計

  • 月次分析

12. エラー対応

  • 200:正常

  • 401:認証エラー

確認項目:

  • APIキー

  • リクエスト形式

13. サポート

Email: [email protected]
URL:
https://app.flow-insight.com/general


この回答が役に立ちましたか?
😞
😐
😁