Flow API Documentation

The Flow Reporting provides a programmable way to receive your requested data.

Overview

The data recorded by devices can be gathered through the following outlined steps below.

• Step 1: Obtain the API Secret Key from the Flow Technical Team by requesting through email at support@flow-solutions.com

• Step 2: Set the obtained API Secret Key in the headers using X-Secret-Key to establish your identification within the Flow Reporting system.

• Step 3: Provide the required data in the payload to receive a faster response from the Flow Reporting system.

• Step 4: Utilize the provided test script under the "Test" tab for your requests. You can copy, modify, and execute the script to validate the functionality.

Resource: Visualizing Responses

Explore and visualize the responses to better understand and interpret the data obtained through the Flow Reporting API.

Pro tips

Request Understanding

Each API response returns the following set of headers to help you identify your use status:

401 response

An HTTP 401 response from our servers indicates that there is something not correct as expected and a message will appear mentioning the details. Please contact Flow in case of required any support.

200 response

An HTTP 200 response from our servers indicates that the request has been processed successfully and data will be received by the requester.

Contact Us

Email: support@flow-solutions.com

POST Get Hourly KPIs

https://reporting-api.flow-insight.com/rest/kpis/hourly

Request:

• date

  • requested data for data in the format (YYYY-MM-DD)

• storeCodes

  • data for requested stores (must be less than 20 for one request)

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"
    ]
}'

Response:

The data returned will be hourly based on the open hours set on Flow Web App. The KPI data will be:

• Traffic

• Passersby

• Demographics

• Sales

• Transactions

• Items Sold

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
}

HEADERS

Body

{
    "date": "2024-01-16",
    "storeCodes": [
        "001"
    ]
}