https://www.footfallcam.com/people-counting People Counter | People Counting Solution | Customer Counting Wed, 29 Oct 2025 06:59:18 +0000 en-GB hourly 1 https://wordpress.org/?v=5.4.19 Device REST API https://www.footfallcam.com/people-counting/knowledge-base/device-rest-api/ Thu, 28 Oct 2021 08:48:35 +0000 https://www.footfallcam.com/people-counting/?post_type=ht_kb&p=29311 Endpoint Description Method Frequency {ServerIPOrDomainName}/api/action/GetSettingPiBySerial?serial={serial} Device will call this endpoint to synchronize the configuration data between server and device POST Hourly {ServerIPOrDomainName}/api/action/HeartbeatLite?serial={serial} Device will call this API to send a ping to the server to indicate that it's still able to contact   Topic Description Frequency healthchecklog Device will send...

The post Device REST API appeared first on FootfallCam.

]]> Endpoint Description Method Frequency {ServerIPOrDomainName}/api/action/GetSettingPiBySerial?serial={serial} Device will call this endpoint to synchronize the configuration data between server and device POST Hourly {ServerIPOrDomainName}/api/action/HeartbeatLite?serial={serial} Device will call this API to send a ping to the server to indicate that it's still able to contact

 

Topic Description Frequency
healthchecklog Device will send health check payload to this topic for near real time health check monitoring Every 5 seconds
ffc-eventrawdata Device will send counting data payload to this topic whenever detected moving object Event triggered

Data payload that device will push to server websocket topic

ProWave Data Retrieval API

Authentication

Endpoint: v1/auth/

  • Method: POST

  • Description: Authenticates the user and returns a token

  • Headers:

    • Content-Type: application/json

  • Request Body:

{
    "username": "string",
    "password": "string"
}

  • Response:

    • Success: 200 OK

    • Failure: 401 Unauthorized

{
"token": "string"
}

Sensor Data Retrieval

Endpoint: v1/data/occupancyraw

  • Method: GET

  • Description: Get occupancy data, i.e. total number of people in the tracking zone

  • Headers:

    • Content-Type: application/json

    • Authorization: "TokenString"

  • Response:

    • Success: 200 OK

Occupancy Data:

{

"RoiId": 1,
"CombineObjectTypeId": 1,
"ObjectCount": 5, #Number of people in tracking zone
"Timestamp": 1672889540, #UTCtime
"LocalTime": "2024-01-05 11:32:20",
"UTCTime": "2024-01-05 03:32:20",
"OccupancyTypeId": 1,
"ObjectCountUnit": 1

}

    • Failure: 401 Unauthorized

Endpoint: v1/data/eventraw

  • Method: GET

  • Description: Get raw data for various footfall events, including In, Out, Heat Dwell,
    Serve Time, Wait Time, etc.

  • Headers:

    • Content-Type: application/json

    • Authorization: "TokenString"

  • Params:
Parameter Description Value Sample
Date Start Start date of the data yyyymmdd date_start=20241001
Date End End date of the data yyyymmdd date_end=20241002
Time Start Start time of the data HHMMSS time_start=090000
Time End End time of the data HHMMSS time_end=180000

  • Response:

    • Success: 200 OK

{

"RoiId": 1, #Unique for each ROI defined
"MetricId": 3, #3 for Heat Dwell
"PeopleTypeId": 1,
"CombineObjectTypeId": 11,
"PeopleId": 1,
"EventEndLocalTime": "2024-11-25 04:47:59",
"EventEndTime": 1672889550,
"EventEndUTCTime": "2024-11-25 04:47:59",
"EventStartLocalTime": "2024-11-25 04:47:49",
"EventStartTime": 1672889540,
"EventStartUTCTime": "2024-11-25 04:47:49"

}

    • Failure: 401 Unauthorized

Endpoint: v1/prowave/data/heatmap

  • Method: GET

  • Description: Get 15min aggregated heatmap data

  • Headers:

    • Content-Type: application/json

    • Authorization: "TokenString"

  • Params:
Parameter Description Sample
Start Timestamp Start date of the data starttime=1732508403
End Timestamp End date of the data endtime=1732513804

*Heatmap data from the last 15min will be returned if no param is specified.

  • Response:

    • Success: 200 OK

{

"data": [ #multiple JSON objects will be returned
based on the start and end time range

{

"AggregationInterval": 900, #in seconds
"CombineObjectTypeId": 1,
"Data": [

{

"PasserBy": [],
"PeopleOccHeat": 0,
"PixelOccHeat": 0,
"x": 9, #in pixel
"y": 22 #in pixel

},
{

...

},
...

],
"FloorPlanId": 276,
"HeatmapHeight": 50, #in pixel
"HeatmapTypeId": 2, #for FFC data pipeline use
"HeatmapWidth": 50, #in pixel
"LocalTime": "2024-11-26 17:15:00",
"RoiId": 1,
"Timestamp": 1732612500,
"UTCTime": "2024-11-26 09:15:00"

},
...

],
"status": "ok"

}

*Note: ProWave heatmap is segmented into a 50 x 50 pixels matrix,
representing a 100m² coverage area.

    • PixelOccHeat is the EFFECTIVE duration a pixel get occupied, i.e. if there are >2 people in the same pixel as the same time, only consider once

    • PeopleOccHeat is the TOTAL duration a pixel get occupied, i.e. if there are >2 people in the same pixel at the same time, it is sum of all people

  • Failure: 401 Unauthorized

  • Not Found 404 : No heatmap data found for the specified time range

Endpoint: v1/prowave/data/pointcloud

  • Method: GET

  • Description: Get aggregated point cloud data in per frame resolution

  • Headers:

    • Content-Type: application/json

    • Authorization: "TokenString"

  • Params:
Parameter Description Sample
Start Timestamp Start date of the data starttime=1732508403
End Timestamp End date of the data endtime=1732513804

  • Response:

    • Success: 200 OK

{

"data": [ #multiple JSON objects will be returned based on the start and end time range

{

"timestamp": "2024-11-23 15:30:00",
"frame_id": 102,
"azimuth": [

-0.14999999105930328,
-0.14000000059604645,
-0.14000000059604645

],
"elevation": [

-1.0,
-0.9599999785423279,
-0.9300000071525574

],
"range": [

1.6967500448226929,
1.6967500448226929,
1.6967500448226929

],
"doppler": [

-0.05628000199794769,
0.7887600064277649,
-0.28168001770973206

],
"snr": [

5.639999866485596,
10.0,
45.36000061035156

],
"tid": [

0,
1

],
"posX": [

-0.912135660648346,
-0.24295669794082642

],
"posY": [

1.9702520370483398,
1.8161014318466187

],
"posZ": [

-1.8553844690322876,
0.503157377243042

]

},
...

],

"frame_rate": 5,
"status": "ok"

}

*Note: Individual points in the point cloud data are provided in polar coordinates formats, represented as the distance and angles relative to the sensor, along with the doppler (velocity of the point) and the snr (signal-to-noise ratio) of the reflected signal. "tid" field indicates the number of tracked objects in the current frame, and "posX", "posY" and "posZ" indicate the spatial location of the tracked object's centroid point in 3D space.

    • Failure: 401 Unauthorized

    • Not Found 404 : No point cloud data found for the specified time range

The post Device REST API appeared first on FootfallCam.

]]> Access Token https://www.footfallcam.com/people-counting/knowledge-base/access-token/ Sun, 17 Oct 2021 05:00:52 +0000 https://www.footfallcam.com/people-counting/?post_type=ht_kb&p=28764 Generate Access Token Description Calling this endpoint by providing the user name & password to generate access token.For account that has upgraded to V9, please use email & password instead. Access token will be needed to pass through the RESTful API header as "AToken".If "expiration" field is not provided/not valid,...

The post Access Token appeared first on FootfallCam.

]]> Generate Access Token

Description

Calling this endpoint by providing the user name & password to generate access token.
For account that has upgraded to V9, please use email & password instead.

Access token will be needed to pass through the RESTful API header as "AToken".
If "expiration" field is not provided/not valid, the AToken returned will be valid for 1 day by default.
Endpoint {AnalyticManagerHostAddress}/account/GenerateAccessToken
Method POST
Body - JSON {
    "email": "Analytic Manager user email",
    "password": "Analytic Manager user password",
    "expiration": "Expiration date (UTC +0) of token, example: 2020-03-15"
}
Response {
    "AToken": "0980574983072035421341004C00640044005A005600430071005800700057004E007900470030007900660053007100670044006E00760046006A0070004408798968G6FDS879G899H789GVJKCBXIU89AYF494375089230589032UT8799258790758093798UTGHG078006C003200480030007A0041007600390032004D0054004C0068004A0075003500770061006700760075006C0044006C00750077006D004E0078007A0077007300740064006100350034004A00420054004A0068006E00710074006D00450072004E006C0035004500670056004C004A006F002B003200310066006700570058006300510038006B007000630037006B004F00550049006C003200450063007A005800300068004200720050005900750037002F00390076004400440038006500690048003700350049003000360051004700720078004800620049005A002B00470076006A0036006600580071005A002F006D00480036004B004A0054002F0070006A00390058006C0048004D0041004400570056007800320032J98GF8G87840905606JKNS9AS98354002F006700430068006B005800410063004F007A00310037003300620036003400460071006800770066004E006E004F0032006E0055005100500045003900790053006E0051006300770036007300700038006D005A004A00520079007KLKFS99495U85689998900390935903059309503953905930"
}
Remark

{AnalyticManagerHostAddress}: https://v9.footfallcam.com (if you're using on-premise solution, please consult FootfallCam Support on the host address)

If your API returned 'user configuration error', please look into the response message for more details.

Check if your user account has upgraded to V9, or if there are multiple users using the same email.
In these cases, please upgrade the affected accounts to V9 and try again. Kindly contact Footfallcam support if you are unsure on how to proceed.

The post Access Token appeared first on FootfallCam.

]]> DataManagerAPI Bearer Token https://www.footfallcam.com/people-counting/knowledge-base/datamanagerapi-bearer-token/ Wed, 17 Nov 2021 09:08:29 +0000 https://www.footfallcam.com/people-counting/?post_type=ht_kb&p=29768 Generate Access Token Description This endpoint will generate DataManagerAPI Bearer Token by providing the AToken returnedfrom API 'GenerateAccessToken'. Endpoint {DataManagerHostAddress}/account/AuthorizeUser?token=[AToken from API 'GenerateAccessToken'] {DataManagerHostAddress}: https://data.footfallcam.com (if you're using on-premise solution, please consult FootfallCam Support on the host address) Method GET Response {    "jwtToken": "eyJKEIRNFF94JernjnfKOKO90J4jnSJIjJHjIHnjHfLKFRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiNDgwMDMwMDA0NTAwNjgwMDQxMDA2QzAwNjQwMDU1MDAzMzAwNDIwMDQ3MDA0RTAwNkYwMDRDMDA2NDAwNDQwMDVBMDA1NjAwNDMwMDcxM54353JiutUiHHi*fjSAAwNkMwMDZGMDA2QTAwNkMwMDcxMDA0ODAwNjIwMDU1MDA1ODAwNzgwMDc5MDA3OTAwNDcwMDQyMDA2QTAwNTUwMDQ0MDA1ODAwNEQwMDYzMDA3MTAwNTcwMDQ4MDAyRjAwNTUwMDZBMDA0MzAwNzEwMDJGMDA3MDAwNTEwMDc0MDA2NTAwNEYwMDYyMDA2RTAwNkMwMDQyMDA0NzAwNjYwMDMyMDAzNjAwNkEwMDYzMDAzMzAwNzAwMDM5MDAzODAwNzkwMDM4MDA2NTAwNTQwMDQ1MDAzMzAwNzMwMDQ4MDA0MjAwMkYwMDQ5MDA0NzAwMzEwMDYzMDA2RDAwNzkwMDM0MDA1NTAwNDUwMDcwMDA3NzAwNzMwMDY0MDA3MzAwNjcwMDY2MDA0MzAwNEIwMDc2MDA3NzAwNkUwMDRDMDAzODAwMzMwMDQ0MDA0NDAwNzIwMDQ0MDA2MjAwMzQwMDVBMDA3MTAwNTAwMDU3MDA2NDAwNjIwMDY0MDA1MjAwMzgwMDdBMDA2NTAwNjUwMDMwMDA0MTAwNEIwMDYzMDA0NzAwNjUwMDMxMDA0QjAwMzQwMDYzMDAzODAwMzEwMDU1MDA1ODAwNjcwMDZGMDA2ODAwNTkwMDRGMDA3NjAwNTgwMDRGMDA0OTAwNkIwMDU2MDAyRjAwNzIwMDUzMDA2RjAwNEIwMDVBMDA0QTAwNzQwMDY2MDA0OTAwNjgwMDRGMDAzNzAwNTkwMDc3MDAzNTAwNzkwMDQxMDA3NDAwNjkwMDczMDA3MzAwNTEwMDM2MDA2RTAwNjgwMDRFMDA2MjAwNzEwMDMzMDA0RTAwMzYwMDM0MDAzNjAwNTgwMDRGMDA2RDAwNEYwMDQ4MDAzMDAwNTcwMDc3MDA2OTAwNDcwMDREMDA0NjAwNDcwMDYyMDA3MDAwMzkwMDQxMDAzNDAwNEEwMDJGMDA0QjAwNzYwMDRBMDAzNTAwNTYwMDMyMDA0ODAwNEQwMDc0MDA2MTAwNTcwMDRBMDA3NTAwNEQwMDU0MDA3QTAwNzYwMDcxMDAzNTAwNDUwMDJCMDAzMDAwNEQwMDU1MDA0OTAwNEMwMDU1MDA1ODAwNTUwMDMxMDA3MjAwMzIwMDc1MDA2MjAwNjQwMDJGMDA0RTAwNTYwMDZDMDAzNjAwNDcwMDYyMDA0NDAwNDUwMDREMDA2MTAwNjYwMDY0MDA0RTAwNjIwMDc5MDA1MzAwNzUwMDQ0MDA3MzAwNDcwMDc3MDA1ODAwNEEwMDZBMDA3NDAwNzAwMDU1MDA3NjAwNjMwMDUxMDA1OTAwNDMwMDQ3MDAzMTAwNzQwMDM3MDA2OTAwMzcwMDM5MDA3QTAwNjkwMDM5MDA0QzAwNTIwMDc1MDA0MjAwNUEwMDM4MDA2RDAwNDcwMDU2MDA0RDAwNzMwMDRFMDAyRjAwNkIwMDU4MDAzMDAwNTQwMDM1MDA1MTAwNzQwMDU3MDA3MjAwNTUwMDczMDA1MjAwNDcwMDQ5MDA0RjAwMzMwMDQyMDA1NjAwMzIwMDVBMDA2OTAwNjgwMDZGMDAzNTAwNzQwMDUwMDA1NTAwNkwMDc2MDA1NTAwNzAwMDM3M6543U3MDA3MjAwMzIwMDc0MDA0QzAwNTkwMDU4MDA0NzAwNzIwMDU0MDA0NTAwNEQwMDZFMDAzMDAwNjEwMDQzMDA0MjAwNzYwMDRDMDA2RjAwMzEwMDc1MDA0NTAwNDQwMDc0MDAzMjAwNzYwMDU5MDAzMjAwNzUwMDMxMDA0NTAwNzkwMDUyMDA1MDAwNDQwMDJCMDA1NTAwNkMwMDM3MDA1MzAwMzMwMDU1MDA1NTAwNDcwMDM4MDA1MzAwNTUwMDQ3MDA3MzAwNDEwMDNEMDAzRDAwIiwianRpIjoiMDcwNmRkNjAtOTkwZC00OGE0LTliOGYtYWNkYjA3ZmMxN2QyIiwiZXhwIjoxNjY4NjY3MjQ1LCJpc3MiOiJodHRwOi8vbG9jYWxob3N0Ojg5MDAiLCJhdWQiOiJodHRwOi8vbG9jYWxob3N0Ojg5MDAifQ.HmFq-uSoReAjNR_dSUDagdRMATND32bZA-E",    "expiration": "2021-11-17T06:40:45Z"}

The post DataManagerAPI Bearer Token appeared first on FootfallCam.

]]> Generate Access Token

Description This endpoint will generate DataManagerAPI Bearer Token by providing the AToken returned
from API 'GenerateAccessToken'.
Endpoint

{DataManagerHostAddress}/account/AuthorizeUser?token=[AToken from API 'GenerateAccessToken']

{DataManagerHostAddress}: https://data.footfallcam.com (if you're using on-premise solution, please consult FootfallCam Support on the host address)
Method GET
Response {
    "jwtToken": "eyJKEIRNFF94JernjnfKOKO90J4jnSJIjJHjIHnjHfLKFRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiNDgwMDMwMDA0NTAwNjgwMDQxMDA2QzAwNjQwMDU1MDAzMzAwNDIwMDQ3MDA0RTAwNkYwMDRDMDA2NDAwNDQwMDVBMDA1NjAwNDMwMDcxM54353JiutUiHHi*fjSAAwNkMwMDZGMDA2QTAwNkMwMDcxMDA0ODAwNjIwMDU1MDA1ODAwNzgwMDc5MDA3OTAwNDcwMDQyMDA2QTAwNTUwMDQ0MDA1ODAwNEQwMDYzMDA3MTAwNTcwMDQ4MDAyRjAwNTUwMDZBMDA0MzAwNzEwMDJGMDA3MDAwNTEwMDc0MDA2NTAwNEYwMDYyMDA2RTAwNkMwMDQyMDA0NzAwNjYwMDMyMDAzNjAwNkEwMDYzMDAzMzAwNzAwMDM5MDAzODAwNzkwMDM4MDA2NTAwNTQwMDQ1MDAzMzAwNzMwMDQ4MDA0MjAwMkYwMDQ5MDA0NzAwMzEwMDYzMDA2RDAwNzkwMDM0MDA1NTAwNDUwMDcwMDA3NzAwNzMwMDY0MDA3MzAwNjcwMDY2MDA0MzAwNEIwMDc2MDA3NzAwNkUwMDRDMDAzODAwMzMwMDQ0MDA0NDAwNzIwMDQ0MDA2MjAwMzQwMDVBMDA3MTAwNTAwMDU3MDA2NDAwNjIwMDY0MDA1MjAwMzgwMDdBMDA2NTAwNjUwMDMwMDA0MTAwNEIwMDYzMDA0NzAwNjUwMDMxMDA0QjAwMzQwMDYzMDAzODAwMzEwMDU1MDA1ODAwNjcwMDZGMDA2ODAwNTkwMDRGMDA3NjAwNTgwMDRGMDA0OTAwNkIwMDU2MDAyRjAwNzIwMDUzMDA2RjAwNEIwMDVBMDA0QTAwNzQwMDY2MDA0OTAwNjgwMDRGMDAzNzAwNTkwMDc3MDAzNTAwNzkwMDQxMDA3NDAwNjkwMDczMDA3MzAwNTEwMDM2MDA2RTAwNjgwMDRFMDA2MjAwNzEwMDMzMDA0RTAwMzYwMDM0MDAzNjAwNTgwMDRGMDA2RDAwNEYwMDQ4MDAzMDAwNTcwMDc3MDA2OTAwNDcwMDREMDA0NjAwNDcwMDYyMDA3MDAwMzkwMDQxMDAzNDAwNEEwMDJGMDA0QjAwNzYwMDRBMDAzNTAwNTYwMDMyMDA0ODAwNEQwMDc0MDA2MTAwNTcwMDRBMDA3NTAwNEQwMDU0MDA3QTAwNzYwMDcxMDAzNTAwNDUwMDJCMDAzMDAwNEQwMDU1MDA0OTAwNEMwMDU1MDA1ODAwNTUwMDMxMDA3MjAwMzIwMDc1MDA2MjAwNjQwMDJGMDA0RTAwNTYwMDZDMDAzNjAwNDcwMDYyMDA0NDAwNDUwMDREMDA2MTAwNjYwMDY0MDA0RTAwNjIwMDc5MDA1MzAwNzUwMDQ0MDA3MzAwNDcwMDc3MDA1ODAwNEEwMDZBMDA3NDAwNzAwMDU1MDA3NjAwNjMwMDUxMDA1OTAwNDMwMDQ3MDAzMTAwNzQwMDM3MDA2OTAwMzcwMDM5MDA3QTAwNjkwMDM5MDA0QzAwNTIwMDc1MDA0MjAwNUEwMDM4MDA2RDAwNDcwMDU2MDA0RDAwNzMwMDRFMDAyRjAwNkIwMDU4MDAzMDAwNTQwMDM1MDA1MTAwNzQwMDU3MDA3MjAwNTUwMDczMDA1MjAwNDcwMDQ5MDA0RjAwMzMwMDQyMDA1NjAwMzIwMDVBMDA2OTAwNjgwMDZGMDAzNTAwNzQwMDUwMDA1NTAwNkwMDc2MDA1NTAwNzAwMDM3M6543U3MDA3MjAwMzIwMDc0MDA0QzAwNTkwMDU4MDA0NzAwNzIwMDU0MDA0NTAwNEQwMDZFMDAzMDAwNjEwMDQzMDA0MjAwNzYwMDRDMDA2RjAwMzEwMDc1MDA0NTAwNDQwMDc0MDAzMjAwNzYwMDU5MDAzMjAwNzUwMDMxMDA0NTAwNzkwMDUyMDA1MDAwNDQwMDJCMDA1NTAwNkMwMDM3MDA1MzAwMzMwMDU1MDA1NTAwNDcwMDM4MDA1MzAwNTUwMDQ3MDA3MzAwNDEwMDNEMDAzRDAwIiwianRpIjoiMDcwNmRkNjAtOTkwZC00OGE0LTliOGYtYWNkYjA3ZmMxN2QyIiwiZXhwIjoxNjY4NjY3MjQ1LCJpc3MiOiJodHRwOi8vbG9jYWxob3N0Ojg5MDAiLCJhdWQiOiJodHRwOi8vbG9jYWxob3N0Ojg5MDAifQ.HmFq-uSoReAjNR_dSUDagdRMATND32bZA-E",
    "expiration": "2021-11-17T06:40:45Z"
}

The post DataManagerAPI Bearer Token appeared first on FootfallCam.

]]> Counting Data API [Beta] https://www.footfallcam.com/people-counting/knowledge-base/counting-data-api/ Thu, 21 Oct 2021 09:38:16 +0000 https://www.footfallcam.com/people-counting/?post_type=ht_kb&p=28891   Description Calling this endpoint by providing the type of counting data & query payload object in JSON string to get counting data in JSON format. Endpoint {CubeHostAddress}/API/v1/load {CubeHostAddress}: https://cube.footfallcam.com (if you're using on-premise solution, please consult FootfallCam Support on the host address) Method POST Headers Authorization : Token value...

The post Counting Data API [Beta] appeared first on FootfallCam.

]]>  

Description Calling this endpoint by providing the type of counting data & query payload object in JSON string to get counting data in JSON format.
Endpoint

{CubeHostAddress}/API/v1/load

{CubeHostAddress}: https://cube.footfallcam.com (if you're using on-premise solution, please consult FootfallCam Support on the host address)
Method POST
Headers
  1. Authorization : Token value return from API 'GenerateAccessToken' by providing the user name & password
Body - JSON Example {
    "query": {
        "measures": [
            "ThisCubeName.FC01_SUM",
            "ThisCubeName.FC01_AVG",
            "ThisCubeName.FC02_SUM",
            "ThisCubeName.FC02_AVG"
        ],
        "timeDimensions": [
            {
                "dimension": "ThisCubeName.Time",
                "dateRange": [
                    "2021-10-01T10:00:00.000",
                    "2021-10-31"
                ],
                "granularity": "hour"
            }
        ],
        "order": [
            [
                "ThisCubeName.FC01_SUM",
                "desc"
            ]
        ],
        "filters": [
            {
                "member": "ThisCubeName.CompanyId",
                "operator": "equals",
                "values": [
                    "1001"
                ]
            },
            {
                "member": "ThisCubeName.BranchId",
                "operator": "equals",
                "values": [
                    "2001",
                    "2001"
                ]
            },
            {
                "member": "ThisCubeName.BranchName",
                "operator": "equals",
                "values": [
                    "BranchName1",
                    "BranchName2"
                ]
            },
            {
                "member": "ThisCubeName.AreaId",
                "operator": "equals",
                "values": [
                    "3001",
                    "3002",
                    "3003"
                ]
            }
        ],
        "dimensions": [
            "ThisCubeName.CompanyId",
            "ThisCubeName.CompanyName",
            "ThisCubeName.BranchId",
            "ThisCubeName.BranchName",
            "ThisCubeName.AreaId",
            "ThisCubeName.AreaName"
        ],
        "limit" : 50000
    }
}
Body Description

Cube name must be mentioned in payload and its available fields depends on cube selected. Please refer list of cube for cube details

  1. query (object) : To define payload for query data
  2. measures (list of string) : To define list of metric codes and type of aggregation.
  3. timeDimensions (list of object) : Contains an object to define time related parameters
    1. dimension (string) : To specify dimension for applying time related parameters
    2. dateRange (list of string) : To specify start and end date time for data query. Example: "2021-10-01T10:00:00.000", "2021-10-31"
    3. granularity (string) : To define time granularity for data. Example: minute, hour, day, week, month, year
  4. order (list of list of string) : To specify ordering of data. Each minor list contains field name to apply ordering and respective type of ordering. Example : ["ThisCubeName.FC01_SUM", "desc"]
  5. filters (list of object) : To define filtering of query data.
    1. member (string) : To specify dimension for applying filter.
    2. operator (string) : To define type for filter. Example: equals, notEquals, contains, notContains
    3. values (list of string) : To specify value for filtering data.
  6. dimensions (list of string) : To specify dimension to display in result data, similar to 'Select' statement in SQL query.
  7. limit (int, optional) : To specify maximum record count of data returned. Default value will be 10000 (if not specified in payload), maximum value is 50000.
Response 1 - JSON Example {
    "error": "Continue wait",
    "stage": {
        "stage": "Executing query",
        "timeElapsed": 5003
    }
}
Response 1 Description The 'Continue Wait' response simply an indication that the backend may takes sometime to execute the query and return result. It is not due to failed API call, the query is executing at backend. Retry afterward and the API will return result once the backend finish execute the query.
Response 2 - JSON Example {
    "query": {},
    "data": [
{
            "cube3.CompanyId": "18330",
            "cube3.CompanyName": "DemoCompany",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.AreaId": "-1",
            "cube3.AreaName": null,
            "cube3.Time.hour": "2022-01-15T11:00:00.000",
            "cube3.Time": "2022-01-15T11:00:00.000",
            "cube3.FC01_SUM": 200,
            "cube3.FC01_MAX": 180,
            "cube3.FC01_AVG": 100,
            "cube3.FC01_MIN": 20,
            "cube3.FC02_SUM": 188,
            "cube3.FC02_MAX": 171,
            "cube3.FC02_AVG": 94,
            "cube3.FC02_MIN": 17
        },
        {
            "cube3.CompanyId": "18330",
            "cube3.CompanyName": "DemoCompany",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.AreaId": "-1",
            "cube3.AreaName": null,
            "cube3.Time.hour": "2022-01-07T15:00:00.000",
            "cube3.Time": "2022-01-07T15:00:00.000",
            "cube3.FC01_SUM": 175,
            "cube3.FC01_MAX": 100,
            "cube3.FC01_AVG": 87.5,
            "cube3.FC01_MIN": 75,
            "cube3.FC02_SUM": 174,
            "cube3.FC02_MAX": 95,
            "cube3.FC02_AVG": 87,
            "cube3.FC02_MIN": 79
        },
        {
            "cube3.CompanyId": "18330",
            "cube3.CompanyName": "DemoCompany",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.AreaId": "-1",
            "cube3.AreaName": null,
            "cube3.Time.hour": "2022-01-15T13:00:00.000",
            "cube3.Time": "2022-01-15T13:00:00.000",
            "cube3.FC01_SUM": 171,
            "cube3.FC01_MAX": 151,
            "cube3.FC01_AVG": 85.5,
            "cube3.FC01_MIN": 20,
            "cube3.FC02_SUM": 166,
            "cube3.FC02_MAX": 146,
            "cube3.FC02_AVG": 83,
            "cube3.FC02_MIN": 20
        }
],
    "lastRefreshTime": "2022-01-19T07:35:41.259Z",
    "refreshKeyValues": [
        [
            {
                "refresh_key": "13688147"
            }
        ]
    ],
    "usedPreAggregations": {},
    "transformedQuery": {},
    "requestId": "dda53bef-4d52-4377-aee8-74d2976cafc6-span-1",
    "annotation": {},
    "dataSource": "default",
    "dbType": "prestodb",
    "extDbType": "cubestore",
    "external": false,
    "slowQuery": false
}
Response 2 Description Counting data result will be in 'data' section as list of objects, other additional information may be remove in future.

The post Counting Data API [Beta] appeared first on FootfallCam.

]]> Product API https://www.footfallcam.com/people-counting/knowledge-base/product-related-restful-api/ Sat, 16 Oct 2021 17:08:05 +0000 https://www.footfallcam.com/people-counting/?post_type=ht_kb&p=28739 Notes: {AnalyticsManagerDataManagerApiAddress}: https://data.footfallcam.com (if you're using on -premise solution, please ask FootfallCam Support for the host DataManagerApi address {AToken}: Refer to this guide on how to generate access token Entity relationship diagram for product related objects

The post Product API appeared first on FootfallCam.

]]> Notes:

  • {AnalyticsManagerDataManagerApiAddress}: https://data.footfallcam.com (if you're using on -premise solution, please ask FootfallCam Support for the host DataManagerApi address

  • {AToken}: Refer to this guide on how to generate access token

  • Entity relationship diagram for product related objects

The post Product API appeared first on FootfallCam.

]]> Devices https://www.footfallcam.com/people-counting/knowledge-base/devices/ Thu, 23 Dec 2021 03:48:23 +0000 https://www.footfallcam.com/people-counting/?post_type=ht_kb&p=30031 Read Devices Description Pull all devices under the company & server Endpoint {DataManagerAPI}/api/Devices Method GET Request Headers AToken (Guide on how to obtain AToken here) Response {     "Status": 200,     "Error": "",     "Message": "OK",     "Data": [         {    ...

The post Devices appeared first on FootfallCam.

]]> Read Devices
Description Pull all devices under the company & server
Endpoint {DataManagerAPI}/api/Devices
Method GET
Request Headers AToken (Guide on how to obtain AToken here)
Response
{
    "Status": 200,
    "Error": "",
    "Message": "OK",
    "Data": [
        {
            "Serial": "10000001",
            "CameraName": "VirtualDevice01",
            "LastAllocationDateTime": "2021-12-02T06:58:46Z",
            "LastHeartBeatDateTime": "2023-06-15T03:46:34.787Z",
            "TunedDate": "1970-01-01T00:00:00Z"
        },
        {
            "Serial": "10000002",
            "CameraName": "VirtualDevice02",
            "LastAllocationDateTime": "2021-12-02T07:06:28Z",
            "LastHeartBeatDateTime": "2023-06-15T03:46:34.787Z",
            "TunedDate": "2022-03-21T09:05:00Z"
        }
    ]
}
Remark
{DataManagerAPI}: https://data.footfallcam.com/
(if you're using on-premise solution, please consult FootfallCam Support on the host address)

The post Devices appeared first on FootfallCam.

]]> Sites https://www.footfallcam.com/people-counting/knowledge-base/sites/ Thu, 23 Dec 2021 03:59:19 +0000 https://www.footfallcam.com/people-counting/?post_type=ht_kb&p=30039 Read Sites Description Pull all sites under the company & server Endpoint {DataManagerAPI}/api/Sites Method GET Request Headers AToken (Guide on how to obtain AToken here) Response {     "Status": 200,     "Error": "",     "Message": "OK",     "Data": [         {             "BranchId": 23099,             "BranchName": "AsiaSite01",             "BranchCode": " AsiaSite01",             "SiteVerifiedDateTime": "1970-01-01T00:00:00",             "DeviceList": []         },         {             "BranchId": 23100,             "BranchName": "AsiaSite02",             "BranchCode": "...

The post Sites appeared first on FootfallCam.

]]> Read Sites
Description Pull all sites under the company & server
Endpoint {DataManagerAPI}/api/Sites
Method GET
Request Headers

AToken (Guide on how to obtain AToken here)
Response
{
    "Status": 200,
    "Error": "",
    "Message": "OK",
    "Data": [
        {
            "BranchId": 23099,
            "BranchName": "AsiaSite01",
            "BranchCode": " AsiaSite01",
            "SiteVerifiedDateTime": "1970-01-01T00:00:00",
            "DeviceList": []
        },
        {
            "BranchId": 23100,
            "BranchName": "AsiaSite02",
            "BranchCode": " AsiaSite02",
            "SiteVerifiedDateTime": "2022-03-21T09:00:00Z",
            "DeviceList": [
                {
                    "Serial": "10000001",
                    "CameraName": "VirtualDevice01"
                },
                {
                    "Serial": "10000002",
                    "CameraName": "VirtualDevice02"
                }
            ]
        }
    ]
}
Remark
{DataManagerAPI}: https://data.footfallcam.com/
(if you're using on-premise solution, please consult FootfallCam Support on the host address)

The post Sites appeared first on FootfallCam.

]]> Areas https://www.footfallcam.com/people-counting/knowledge-base/areas/ Thu, 23 Dec 2021 04:09:54 +0000 https://www.footfallcam.com/people-counting/?post_type=ht_kb&p=30043 Read Areas Description Pull all areas under the company Endpoint {DataManagerAPI}/api/Areas Method GET Request Headers AToken (Guide on how to obtain AToken here) Response {     "Status": 200,     "Error": "",     "Message": "OK",     "Data": [         {        ...

The post Areas appeared first on FootfallCam.

]]> Read Areas
Description Pull all areas under the company
Endpoint {DataManagerAPI}/api/Areas
Method GET
Request Headers AToken (Guide on how to obtain AToken here)
Response
{
    "Status": 200,
    "Error": "",
    "Message": "OK",
    "Data": [
        {
            "AreaId": 516,
            "AreaName": "AsiaArea01",
            "AreaCode": "AA01",
            "DeviceList": [],
            "ChildAreaList": [
                517
            ]
        },
        {
            "AreaId": 517,
            "AreaName": "AsiaArea02",
            "DeviceList": [
                {
                    "Serial": "10000001",
                    "CameraName": "VirtualDevice01"
                }
            ],
            "ChildAreaList": []
        }
    ]
}
Remark
{DataManagerAPI}: https://data.footfallcam.com/
(if you're using on-premise solution, please consult FootfallCam Support on the host address)

The post Areas appeared first on FootfallCam.

]]> Aggregation Status Definition https://www.footfallcam.com/people-counting/knowledge-base/cube-api-guide/ Mon, 31 Jul 2023 07:36:37 +0000 https://www.footfallcam.com/people-counting/?post_type=ht_kb&p=47469 Why Late Data can happen? Late data can happen when some devices are offline before the data is retrieved via the API. This prevents the data from being sent to our database in real-time.  Below is an example payload and the corresponding output: Payload Output Data "data": [         {             "ffc_site_summary.AggregationStatus": "Complete",  ...

The post Aggregation Status Definition appeared first on FootfallCam.

]]>

Why Late Data can happen?

Late data can happen when some devices are offline before the data is retrieved via the API. This prevents the data from being sent to our database in real-time. 

Below is an example payload and the corresponding output: 
Payload

Copy Code 


{
    "query": {
        "measures": [
            "ffc_site_summary.A01",
            "ffc_site_summary.A02"
        ],
        "dimensions": [
            "ffc_site_summary.AggregationStatus",
            "ffc_site_summary.AggregationStatusLastUpdateUTCDateTime"
        ],
        "filters": [
            {
                "member": "ffc_site_summary.BranchId",
                "operator": "equals",
                "values": [
                    "123"
                ]
            }
        ],
        "timeDimensions": [
            {
                "dimension": "ffc_site_summary.Time",
                "dateRange": [
                    "2024-08-17T00:00:00.000",
                    "2024-08-22T23:59:59.999"
                ],
                "granularity": "day"
            }
        ],
        "order": [
            [
                "ffc_site_summary.Time",
                "asc"
            ]
        ],
        "offset": 0,
        "limit": 100
    }
}


Output Data
"data": [
        {
            "ffc_site_summary.AggregationStatus": "Complete",
            "ffc_site_summary.AggregationStatusLastUpdateUTCDateTime": "2024-08-18T00:13:59.000"
            "ffc_site_summary.Time.day": "2024-08-17T00:00:00.000",
            "ffc_site_summary.Time": "2024-08-17T00:00:00.000",
            "ffc_site_summary.A01": 234,
            "ffc_site_summary.A02": 214
        },
        {
            "ffc_site_summary.AggregationStatus": "Missing Data",
            "ffc_site_summary.AggregationStatusLastUpdateUTCDateTime": "2024-08-18T22:32:02.000"
            "ffc_site_summary.Time.day": "2024-08-18T00:00:00.000",
            "ffc_site_summary.Time": "2024-08-18T00:00:00.000",
            "ffc_site_summary.A01": 112,
            "ffc_site_summary.A02": 84
        },
        {
            "ffc_site_summary.AggregationStatus": "Missing Data",
            "ffc_site_summary.AggregationStatusLastUpdateUTCDateTime": "2024-08-19T21:21:13.000"
            "ffc_site_summary.Time.day": "2024-08-19T00:00:00.000",
            "ffc_site_summary.Time": "2024-08-19T00:00:00.000",
            "ffc_site_summary.A01": 23,
            "ffc_site_summary.A02": 52
        },
        {
            "ffc_site_summary.AggregationStatus": "Missing Data",
            "ffc_site_summary.AggregationStatusLastUpdateUTCDateTime": "2024-08-20T22:13:25.000"
            "ffc_site_summary.Time.day": "2024-08-20T00:00:00.000",
            "ffc_site_summary.Time": "2024-08-20T00:00:00.000",
            "ffc_site_summary.A01": 142,
            "ffc_site_summary.A02": 121
        },
        {
            "ffc_site_summary.AggregationStatus": "Late Data",
            "ffc_site_summary.AggregationStatusLastUpdateUTCDateTime": "2024-08-21T23:58:43.000"
            "ffc_site_summary.Time.day": "2024-08-21T00:00:00.000",
            "ffc_site_summary.Time": "2024-08-21T00:00:00.000",
            "ffc_site_summary.A01": 187,
            "ffc_site_summary.A02": 193
        },
        {
            "ffc_site_summary.AggregationStatus": "Precheck",
            "ffc_site_summary.AggregationStatusLastUpdateUTCDateTime": "2024-08-22T14:23:10.000"
            "ffc_site_summary.Time.day": "2024-08-22T00:00:00.000",
            "ffc_site_summary.Time": "2024-08-22T00:00:00.000",
            "ffc_site_summary.A01": 12,
            "ffc_site_summary.A02": 23
        }
    ],

The post Aggregation Status Definition appeared first on FootfallCam.

]]> List of Cube (Deprecated) https://www.footfallcam.com/people-counting/knowledge-base/list-of-cube/ Wed, 10 Jul 2024 08:48:18 +0000 https://www.footfallcam.com/people-counting/?post_type=ht_kb&p=30639 The cubes listed in this page are deprecated. Please refer to V9 Server API - FootfallCam for updated list of cubes. sitearea_footfallcounting_minute Description Store minute level people counting data Cube Name sitearea_footfallcounting_minute Time granularities Following are available time granularities for this cube, minimum time granularity is 'minute'. minute, hour, day,...

The post List of Cube (Deprecated) appeared first on FootfallCam.

]]> The cubes listed in this page are deprecated. Please refer to V9 Server API - FootfallCam for updated list of cubes.

sitearea_footfallcounting_minute

Description Store minute level people counting data
Cube Name sitearea_footfallcounting_minute
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'minute'.

minute, hour, day, week, month, year
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. FC01_1_SUM
  2. FC01_1_MAX
  3. FC01_1_MIN
  4. FC01_1_AVG
  5. FC02_1_SUM
  6. FC02_1_MAX
  7. FC02_1_MIN
  8. FC02_1_AVG
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (string)
  3. AreaName (string)
  4. BranchId (string)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (string)
  8. CompanyName (string)
  9. isoperating (string)
  10. FC01_1 (int)
  11. FC02_1 (int)

sitearea_footfallcounting_hour

Description Store hour level people counting data
Cube Name sitearea_footfallcounting_hour
Time Granularities

Following are available time granularities for this cube, minimum time granularity is 'hour'.

hour, day, week, month, year
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. FC01_1_SUM
  2. FC01_1_MAX
  3. FC01_1_MIN
  4. FC01_1_AVG
  5. FC02_1_SUM
  6. FC02_1_MAX
  7. FC02_1_MIN
  8. FC02_1_AVG
  9. FC03_1_SUM
  10. FC03_1_MAX
  11. FC03_1_MIN
  12. FC03_1_AVG
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (string)
  3. AreaName (string)
  4. BranchId (string)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (string)
  8. CompanyName (string)
  9. isoperating (string)
  10. FC01_1 (int)
  11. FC02_1 (int)
  12. FC03_1 (double)

sitegroup_footfallcounting_day

Description Site Group day level people counting data
Cube Name sitegroup_footfallcounting_day
Time Granularities

Following are available time granularities for this cube, minimum time granularity is 'day'.

day, week, month, year
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. FC01_1_SUM
  2. FC01_1_MAX
  3. FC01_1_MIN
  4. FC01_1_AVG
  5. FC02_1_SUM
  6. FC02_1_MAX
  7. FC02_1_MIN
  8. FC02_1_AVG
  9. FC03_1_SUM
  10. FC03_1_MAX
  11. FC03_1_MIN
  12. FC03_1_AVG
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (string)
  3. AreaName (string)
  4. BranchId (string)
  5. BranchCode (string)
  6. BranchName (string)
  7. SiteGroupId (string)
  8. SiteGroupName (string)
  9. CompanyId (string)
  10. CompanyName (string)
  11. isoperating (string)
  12. FC01_1 (int)
  13. FC02_1 (int)
  14. FC03_1 (double)

sitegroup_footfallcounting_hour

Description Site Group hour level people counting data
Cube Name sitegroup_footfallcounting_hour
Time Granularities

Following are available time granularities for this cube, minimum time granularity is 'hour'.

hour, day, week, month, year
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. FC01_1_SUM
  2. FC01_1_MAX
  3. FC01_1_MIN
  4. FC01_1_AVG
  5. FC02_1_SUM
  6. FC02_1_MAX
  7. FC02_1_MIN
  8. FC02_1_AVG
  9. FC03_1_SUM
  10. FC03_1_MAX
  11. FC03_1_MIN
  12. FC03_1_AVG
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (string)
  3. AreaName (string)
  4. BranchId (string)
  5. BranchCode (string)
  6. BranchName (string)
  7. SiteGroupId (string)
  8. SiteGroupName (string)
  9. CompanyId (string)
  10. CompanyName (string)
  11. isoperating (string)
  12. FC01_1 (int)
  13. FC02_1 (int)
  14. FC03_1 (double)

site_footfallcounting_15minute

Description Store site minute level people counting data which rolled up to 15 minutes
Cube Name site_footfallcounting_15minute
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'minute'.

minute, hour, day, week, month, year
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. FC01_1_SUM
  2. FC02_1_SUM
  3. SO01_1_SUM
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. BranchId (string)
  3. BranchCode (string)
  4. BranchName (string)
  5. CompanyId (string)
  6. CompanyName (string)
  7. isoperating (string)
  8. IsSiteVerified (string)
  9. SiteVerifiedDate (datetime as string)
Body - JSON Example
{
    "query": {
        "measures": [
            "site_footfallcounting_15minute.FC01_1_SUM",
            "site_footfallcounting_15minute.FC02_1_SUM",
            "site_footfallcounting_15minute.SO01_1_SUM"
        ],
        "dimensions": [
            "site_footfallcounting_15minute.CompanyId",
            "site_footfallcounting_15minute.CompanyName",
            "site_footfallcounting_15minute.BranchId",
            "site_footfallcounting_15minute.BranchName"
        ],
        "filters": [
            {
                "member": "site_footfallcounting_15minute.CompanyId",
                "operator": "equals",
                "values": [
                    "12345"
                ]
            },
            {
                "member": "site_footfallcounting_15minute.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
           {
                "member": "site_footfallcounting_15minute.isoperating",
                "operator": "equals",
                "values": [
                    "true"
                ]
            },
           {
                "member": "site_footfallcounting_15minute.IsSiteVerified",
                "operator": "equals",
                "values": [
                    "true"
                ]
            }
        ],
        "timeDimensions": [
            {
                "dimension": "site_footfallcounting_15minute.Time",
                "dateRange": [
                    "2022-01-01T00:00:00.000",
                    "2022-01-02"
                ],
                "granularity": "minute"
            }
        ],
        "order": [
            [
                "site_footfallcounting_15minute.BranchId",
                "asc"
            ],
            [
                "site_footfallcounting_15minute.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "site_footfallcounting_15minute.CompanyId": "12345",
            "site_footfallcounting_15minute.CompanyName": "DemoCompany",
            "site_footfallcounting_15minute.BranchId": "22222",
            "site_footfallcounting_15minute.BranchName": "DemoBranch",
            "site_footfallcounting_15minute.Time.minute": "2022-01-01T00:00:00.000",
            "site_footfallcounting_15minute.Time": "2022-01-01T00:00:00.000",
            "site_footfallcounting_15minute.FC01_1_SUM": 0,
            "site_footfallcounting_15minute.FC02_1_SUM": 0,
            "site_footfallcounting_15minute.SO01_1_SUM": 0
        },
        {
            "site_footfallcounting_15minute.CompanyId": "12345",
            "site_footfallcounting_15minute.CompanyName": "DemoCompany",
            "site_footfallcounting_15minute.BranchId": "22222",
            "site_footfallcounting_15minute.BranchName": "DemoBranch",
            "site_footfallcounting_15minute.Time.minute": "2022-01-01T09:00:00.000",
            "site_footfallcounting_15minute.Time": "2022-01-01T09:00:00.000",
            "site_footfallcounting_15minute.FC01_1_SUM": 5,
            "site_footfallcounting_15minute.FC02_1_SUM": 2,
            "site_footfallcounting_15minute.SO01_1_SUM": 1
        },
        {
            "site_footfallcounting_15minute.CompanyId": "12345",
            "site_footfallcounting_15minute.CompanyName": "DemoCompany",
            "site_footfallcounting_15minute.BranchId": "22222",
            "site_footfallcounting_15minute.BranchName": "DemoBranch",
            "site_footfallcounting_15minute.Time.minute": "2022-01-01T09:30:00.000",
            "site_footfallcounting_15minute.Time": "2022-01-01T09:30:00.000",
            "site_footfallcounting_15minute.FC01_1_SUM": 3,
            "site_footfallcounting_15minute.FC02_1_SUM": 4,
            "site_footfallcounting_15minute.SO01_1_SUM": 0
        }
    ],
 
    ...
 
}

site_footfallcounting_30minute

Description Store site minute level people counting data which rolled up to 30 minutes
Cube Name site_footfallcounting_30minute
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'minute'.

minute, hour, day, week, month, year
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. FC01_1_SUM
  2. FC02_1_SUM
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. BranchId (string)
  3. BranchCode (string)
  4. BranchName (string)
  5. CompanyId (string)
  6. CompanyName (string)
  7. isoperating (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "site_footfallcounting_30minute.FC01_1_SUM",
            "site_footfallcounting_30minute.FC02_1_SUM"
        ],
        "dimensions": [
            "site_footfallcounting_30minute.CompanyId",
            "site_footfallcounting_30minute.CompanyName",
            "site_footfallcounting_30minute.BranchId",
            "site_footfallcounting_30minute.BranchName"
        ],
        "filters": [
            {
                "member": "site_footfallcounting_30minute.CompanyId",
                "operator": "equals",
                "values": [
                    "12345"
                ]
            },
            {
                "member": "site_footfallcounting_30minute.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
            {
                "member": "site_footfallcounting_30minute.isoperating",
                "operator": "equals",
                "values": [
                    "true"
                ]
            }
        ],
        "timeDimensions": [
            {
                "dimension": "site_footfallcounting_30minute.Time",
                "dateRange": [
                    "2022-01-01T00:00:00.000",
                    "2022-01-02"
                ],
                "granularity": "minute"
            }
        ],
        "order": [
            [
                "site_footfallcounting_30minute.BranchId",
                "asc"
            ],
            [
                "site_footfallcounting_30minute.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "site_footfallcounting_30minute.CompanyId": "12345",
            "site_footfallcounting_30minute.CompanyName": "DemoCompany",
            "site_footfallcounting_30minute.BranchId": "22222",
            "site_footfallcounting_30minute.BranchName": "DemoBranch",
            "site_footfallcounting_30minute.Time.minute": "2022-01-01T00:00:00.000",
            "site_footfallcounting_30minute.Time": "2022-01-01T00:00:00.000",
            "site_footfallcounting_30minute.FC01_1_SUM": 0,
            "site_footfallcounting_30minute.FC02_1_SUM": 0
        },
        {
            "site_footfallcounting_30minute.CompanyId": "12345",
            "site_footfallcounting_30minute.CompanyName": "DemoCompany",
            "site_footfallcounting_30minute.BranchId": "22222",
            "site_footfallcounting_30minute.BranchName": "DemoBranch",
            "site_footfallcounting_30minute.Time.minute": "2022-01-01T09:00:00.000",
            "site_footfallcounting_30minute.Time": "2022-01-01T09:00:00.000",
            "site_footfallcounting_30minute.FC01_1_SUM": 5,
            "site_footfallcounting_30minute.FC02_1_SUM": 2
        },
        {
            "site_footfallcounting_30minute.CompanyId": "12345",
            "site_footfallcounting_30minute.CompanyName": "DemoCompany",
            "site_footfallcounting_30minute.BranchId": "22222",
            "site_footfallcounting_30minute.BranchName": "DemoBranch",
            "site_footfallcounting_30minute.Time.minute": "2022-01-01T09:30:00.000",
            "site_footfallcounting_30minute.Time": "2022-01-01T09:30:00.000",
            "site_footfallcounting_30minute.FC01_1_SUM": 3,
            "site_footfallcounting_30minute.FC02_1_SUM": 4
        }
    ],
 
    ...
 
}

area_footfallcounting_15minute

Description Store area minute level people counting data which rolled up to 15 minutes
Cube Name area_footfallcounting_15minute
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'minute'.

minute, hour, day, week, month, year
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. FC01_1_SUM
  2. FC02_1_SUM
  3. SO01_1_SUM
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (string)
  3. AreaName (string)
  4. BranchId (string)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (string)
  8. CompanyName (string)
  9. isoperating (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "area_footfallcounting_15minute.FC01_1_SUM",
            "area_footfallcounting_15minute.FC02_1_SUM", 
            "area_footfallcounting_15minute.SO01_1_SUM"
        ],
        "dimensions": [
            "area_footfallcounting_15minute.CompanyId",
            "area_footfallcounting_15minute.CompanyName",
            "area_footfallcounting_15minute.BranchId",
            "area_footfallcounting_15minute.BranchName",
            "area_footfallcounting_15minute.AreaId",
            "area_footfallcounting_15minute.AreaName"
        ],
        "filters": [
            {
                "member": "area_footfallcounting_15minute.CompanyId",
                "operator": "equals",
                "values": [
                    "12345"
                ]
            },
            {
                "member": "area_footfallcounting_15minute.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
           {
                "member": "area_footfallcounting_15minute.isoperating",
                "operator": "equals",
                "values": [
                    "true"
                ]
            }
        ],
        "timeDimensions": [
            {
                "dimension": "area_footfallcounting_15minute.Time",
                "dateRange": [
                    "2022-01-01T00:00:00.000",
                    "2022-01-02"
                ],
                "granularity": "minute"
            }
        ],
        "order": [
            [
                "area_footfallcounting_15minute.BranchId",
                "asc"
            ],
            [
                "area_footfallcounting_15minute.AreaId",
                "asc"
            ],
            [
                "area_footfallcounting_15minute.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{
    ...
 
    "data": [
        {
            "area_footfallcounting_15minute.CompanyId": "12345",
            "area_footfallcounting_15minute.CompanyName": "DemoCompany",
            "area_footfallcounting_15minute.BranchId": "22222",
            "area_footfallcounting_15minute.BranchName": "DemoBranch",
            "area_footfallcounting_15minute.AreaId": "-1",
            "area_footfallcounting_15minute.AreaName": null,
            "area_footfallcounting_15minute.Time.minute": "2022-01-01T00:00:00.000",
            "area_footfallcounting_15minute.Time": "2022-01-01T00:00:00.000",
            "area_footfallcounting_15minute.FC01_1_SUM": 0,
            "area_footfallcounting_15minute.FC02_1_SUM": 0,
            "area_footfallcounting_15minute.SO01_1_SUM": 0
        },
        {
            "area_footfallcounting_15minute.CompanyId": "12345",
            "area_footfallcounting_15minute.CompanyName": "DemoCompany",
            "area_footfallcounting_15minute.BranchId": "22222",
            "area_footfallcounting_15minute.BranchName": "DemoBranch",
            "area_footfallcounting_15minute.AreaId": "10101",
            "area_footfallcounting_15minute.AreaName": "DemoArea1",
            "area_footfallcounting_15minute.Time.minute": "2022-01-01T00:00:00.000",
            "area_footfallcounting_15minute.Time": "2022-01-01T00:00:00.000",
            "area_footfallcounting_15minute.FC01_1_SUM": 0,
            "area_footfallcounting_15minute.FC02_1_SUM": 0,
            "area_footfallcounting_15minute.SO01_1_SUM": 0
        },
        {
            "area_footfallcounting_15minute.CompanyId": "12345",
            "area_footfallcounting_15minute.CompanyName": "DemoCompany",
            "area_footfallcounting_15minute.BranchId": "22222",
            "area_footfallcounting_15minute.BranchName": "DemoBranch",
            "area_footfallcounting_15minute.AreaId": "20202",
            "area_footfallcounting_15minute.AreaName": "DemoArea2",
            "area_footfallcounting_15minute.Time.minute": "2022-01-01T00:00:00.000",
            "area_footfallcounting_15minute.Time": "2022-01-01T00:00:00.000",
            "area_footfallcounting_15minute.FC01_1_SUM": 0,
            "area_footfallcounting_15minute.FC02_1_SUM": 0,
            "area_footfallcounting_15minute.SO01_1_SUM": 0
        }
    ],
 
    ...
 
}

area_footfallcounting_30minute

Description Store area minute level people counting data which rolled up to 30 minutes
Cube Name area_footfallcounting_30minute
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'minute'.

minute, hour, day, week, month, year
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. FC01_1_SUM
  2. FC02_1_SUM
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (string)
  3. AreaName (string)
  4. BranchId (string)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (string)
  8. CompanyName (string)
  9. isoperating (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "area_footfallcounting_30minute.FC01_1_SUM",
            "area_footfallcounting_30minute.FC02_1_SUM"
        ],
        "dimensions": [
            "area_footfallcounting_30minute.CompanyId",
            "area_footfallcounting_30minute.CompanyName",
            "area_footfallcounting_30minute.BranchId",
            "area_footfallcounting_30minute.BranchName",
            "area_footfallcounting_30minute.AreaId",
            "area_footfallcounting_30minute.AreaName"
        ],
        "filters": [
            {
                "member": "area_footfallcounting_30minute.CompanyId",
                "operator": "equals",
                "values": [
                    "12345"
                ]
            },
            {
                "member": "area_footfallcounting_30minute.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
           {
                "member": "area_footfallcounting_30minute.isoperating",
                "operator": "equals",
                "values": [
                    "true"
                ]
            }
        ],
        "timeDimensions": [
            {
                "dimension": "area_footfallcounting_30minute.Time",
                "dateRange": [
                    "2022-01-01T00:00:00.000",
                    "2022-01-02"
                ],
                "granularity": "minute"
            }
        ],
        "order": [
            [
                "area_footfallcounting_30minute.BranchId",
                "asc"
            ],
            [
                "area_footfallcounting_30minute.AreaId",
                "asc"
            ],
            [
                "area_footfallcounting_30minute.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{
    ...
 
    "data": [
        {
            "area_footfallcounting_30minute.CompanyId": "12345",
            "area_footfallcounting_30minute.CompanyName": "DemoCompany",
            "area_footfallcounting_30minute.BranchId": "22222",
            "area_footfallcounting_30minute.BranchName": "DemoBranch",
            "area_footfallcounting_30minute.AreaId": "-1",
            "area_footfallcounting_30minute.AreaName": null,
            "area_footfallcounting_30minute.Time.minute": "2022-01-01T00:00:00.000",
            "area_footfallcounting_30minute.Time": "2022-01-01T00:00:00.000",
            "area_footfallcounting_30minute.FC01_1_SUM": 0,
            "area_footfallcounting_30minute.FC02_1_SUM": 0
        },
        {
            "area_footfallcounting_30minute.CompanyId": "12345",
            "area_footfallcounting_30minute.CompanyName": "DemoCompany",
            "area_footfallcounting_30minute.BranchId": "22222",
            "area_footfallcounting_30minute.BranchName": "DemoBranch",
            "area_footfallcounting_30minute.AreaId": "10101",
            "area_footfallcounting_30minute.AreaName": "DemoArea1",
            "area_footfallcounting_30minute.Time.minute": "2022-01-01T00:00:00.000",
            "area_footfallcounting_30minute.Time": "2022-01-01T00:00:00.000",
            "area_footfallcounting_30minute.FC01_1_SUM": 0,
            "area_footfallcounting_30minute.FC02_1_SUM": 0
        },
        {
            "area_footfallcounting_30minute.CompanyId": "12345",
            "area_footfallcounting_30minute.CompanyName": "DemoCompany",
            "area_footfallcounting_30minute.BranchId": "22222",
            "area_footfallcounting_30minute.BranchName": "DemoBranch",
            "area_footfallcounting_30minute.AreaId": "20202",
            "area_footfallcounting_30minute.AreaName": "DemoArea2",
            "area_footfallcounting_30minute.Time.minute": "2022-01-01T00:00:00.000",
            "area_footfallcounting_30minute.Time": "2022-01-01T00:00:00.000",
            "area_footfallcounting_30minute.FC01_1_SUM": 0,
            "area_footfallcounting_30minute.FC02_1_SUM": 0
        }
    ],
 
    ...
 
}

sitearea_footfallcounting_minute_accumulate

Description Store minute level people counting accumulated data
Cube Name sitearea_footfallcounting_minute_accumulate
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'minute'.

minute, hour, day, week, month, year
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. FC05_1_MAX
  2. FC05_1_MIN
  3. FC05_11_MAX
  4. FC05_11_MIN
  5. SO05_1_MAX
  6. SO05_1_MIN
  7. SO05_11_MAX
  8. SO05_11_MIN
  9. SO05_12_MAX
  10. SO05_12_MIN
  11. SO05_21_MAX
  12. SO05_21_MIN
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (string)
  3. AreaName (string)
  4. BranchId (string)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (string)
  8. CompanyName (string)
  9. FC05_1 (int)
  10. FC05_11 (int)
  11. SO05_1 (int)
  12. SO05_11 (int)
  13. SO05_12 (int)
  14. SO05_21 (int)
Body - JSON Example
{
    "query": {
        "measures": [
            "sitearea_footfallcounting_minute_accumulate.SO05_1_MAX"
        ],
        "dimensions": [
            "sitearea_footfallcounting_minute_accumulate.CompanyId",
            "sitearea_footfallcounting_minute_accumulate.CompanyName",
            "sitearea_footfallcounting_minute_accumulate.BranchId",
            "sitearea_footfallcounting_minute_accumulate.BranchName",
            "sitearea_footfallcounting_minute_accumulate.AreaId",
            "sitearea_footfallcounting_minute_accumulate.AreaName"
        ],
        "filters": [
            {
                "member": "sitearea_footfallcounting_minute_accumulate.BranchId",
                "operator": "equals",
                "values": [
                    "12345"
                ]
            },
            {
                "member": "sitearea_footfallcounting_minute_accumulate.AreaId",
                "operator": "equals",
                "values": [
                    "1111"
                ]
            }
        ],
        "timeDimensions": [
            {
                "dimension": "sitearea_footfallcounting_minute_accumulate.Time",
                "dateRange": [
                    "2022-02-01T00:00:00.000",
                    "2022-02-02"
                ],
                "granularity": "minute"
            }
        ],
        "order": [
            [
                "sitearea_footfallcounting_minute_accumulate.Time",
                "desc"
            ]
        ],
        "limit": 1
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "sitearea_footfallcounting_minute_accumulate.CompanyId": "10101",
            "sitearea_footfallcounting_minute_accumulate.CompanyName": "DemoCompany",
            "sitearea_footfallcounting_minute_accumulate.BranchId": "12345",
            "sitearea_footfallcounting_minute_accumulate.BranchName": "DemoBranch",
            "sitearea_footfallcounting_minute_accumulate.AreaId": "1111",
            "sitearea_footfallcounting_minute_accumulate.AreaName": "DemoArea",
            "sitearea_footfallcounting_minute_accumulate.Time.minute": "2022-02-01T23:50:00.000",
            "sitearea_footfallcounting_minute_accumulate.Time": "2022-02-01T23:50:00.000",
            "sitearea_footfallcounting_minute_accumulate.SO05_1_MAX": 84
        }
    ],
 
    ...
 
}

sitearea_buscounting_minute

Description Store site & area minute level bus counting data
Cube Name sitearea_buscounting_minute
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'minute'.

minute, hour, day, week, month, year
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. FC01_1_SUM
  2. FC01_1_MAX
  3. FC01_1_MIN
  4. FC01_1_AVG
  5. FC02_1_SUM
  6. FC02_1_MAX
  7. FC02_1_MIN
  8. FC02_1_AVG
  9. SO01_1_SUM
  10. SO01_1_MAX
  11. SO01_1_MIN
  12. SO01_1_AVG
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. ScheduledStartTime (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  3. ActualArrivalDateTime (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  4. AreaId (string)
  5. AreaName (string)
  6. BranchId (string)
  7. BranchCode (string)
  8. BranchName (string)
  9. CompanyId (string)
  10. CompanyName (string)
  11. FC01_1 (int)
  12. FC02_1 (int)
  13. SO01_1 (int)
Body - JSON Example {
        "query": {
        "measures": [
            "sitearea_buscounting_minute.FC01_1_SUM",
            "sitearea_buscounting_minute.FC02_1_SUM",
            "sitearea_buscounting_minute.SO01_1_SUM"
        ],
        "dimensions": [
            "sitearea_buscounting_minute.TripId",
            "sitearea_buscounting_minute.ScheduledStartTime",
            "sitearea_buscounting_minute.Time",
            "sitearea_buscounting_minute.ActualArrivalDateTime",
            "sitearea_buscounting_minute.CompanyId",
            "sitearea_buscounting_minute.CompanyName",
            "sitearea_buscounting_minute.BranchId",
            "sitearea_buscounting_minute.BranchName",
            "sitearea_buscounting_minute.AreaId",
            "sitearea_buscounting_minute.AreaName"
        ],
        "timeDimensions": [
            {
                "dimension": "sitearea_buscounting_minute.Time",
                "dateRange": [
                    "2022-03-10T00:00:00.000",
                    "2022-03-11"
                ],
                "granularity": "minute"
            }
        ],
    "filters": [
            {
                "member": "sitearea_buscounting_minute.CompanyId",
                "operator": "equals",
                "values": [
                    "12345"
                ]
            },
            {
                "member": "sitearea_buscounting_minute.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
            {
                "member": "sitearea_buscounting_minute.AreaId",
                "operator": "equals",
                "values": [
                    "1101",
                    "2202"
                ]
            },
            {
                "member": "sitearea_buscounting_minute.AreaName",
                "operator": "equals",
                "values": [
                    "Area1",
                    "Area2"
                ]
            }
        ],
        "order": [
            [
                 "sitearea_buscounting_minute.TripId",
                 "asc"
            ],
            [
                 "sitearea_buscounting_minute.AreaId",
                 "asc"
            ],
            [
                 "sitearea_buscounting_minute.ScheduledStartTime",
                 "asc"
            ]
        ]
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "sitearea_buscounting_minute.TripId": "D5975107-F39E-49BC-A975-4016011EA0E7",
            "sitearea_buscounting_minute.StationId": "61025D6D-94A9-4DDE-AE23-BAD5D93BCC03",
            "sitearea_buscounting_minute.ScheduledStartTime": "2022-03-10T18:12:00.000",
            "sitearea_buscounting_minute.Time": "2022-03-10T18:18:46.000",
            "sitearea_buscounting_minute.ActualArrivalDateTime": "2022-03-10T18:18:46.000",
            "sitearea_buscounting_minute.CompanyId": 12345,
            "sitearea_buscounting_minute.CompanyName": "Company1",
            "sitearea_buscounting_minute.BranchId": 11111,
            "sitearea_buscounting_minute.BranchName": "Branch1",
            "sitearea_buscounting_minute.AreaId": 1101,
            "sitearea_buscounting_minute.AreaName": "Area1",
            "sitearea_buscounting_minute.Time.minute": "2022-03-10T18:18:00.000",
            "sitearea_buscounting_minute.FC01_1_SUM": 8,
            "sitearea_buscounting_minute.FC02_1_SUM": 6,
            "sitearea_buscounting_minute.SO01_1_SUM": 2
        },
        {
            "sitearea_buscounting_minute.TripId": "D5975107-F39E-49BC-A975-4016011EA0E7",
            "sitearea_buscounting_minute.StationId": "2D931974-2423-457C-B057-92BD31B5E9FF",
            "sitearea_buscounting_minute.ScheduledStartTime": "2022-03-10T18:14:00.000",
            "sitearea_buscounting_minute.Time": "2022-03-10T18:21:10.000",
            "sitearea_buscounting_minute.ActualArrivalDateTime": "2022-03-10T18:21:10.000",
            "sitearea_buscounting_minute.CompanyId": 12345,
            "sitearea_buscounting_minute.CompanyName": "Company1",
            "sitearea_buscounting_minute.BranchId": 11111,
            "sitearea_buscounting_minute.BranchName": "Branch1",
            "sitearea_buscounting_minute.AreaId": 1101,
            "sitearea_buscounting_minute.AreaName": "Area1",
            "sitearea_buscounting_minute.Time.minute": "2022-03-10T18:21:00.000",
            "sitearea_buscounting_minute.FC01_1_SUM": 0,
            "sitearea_buscounting_minute.FC02_1_SUM": 0,
            "sitearea_buscounting_minute.SO01_1_SUM": 2
        },
        {
            "sitearea_buscounting_minute.TripId": "D5975107-F39E-49BC-A975-4016011EA0E7",
            "sitearea_buscounting_minute.StationId": "E24E9D16-D6D9-432D-ABC8-A9D71C1A4FB1",
            "sitearea_buscounting_minute.ScheduledStartTime": "2022-03-10T18:15:00.000",
            "sitearea_buscounting_minute.Time": "2022-03-10T18:22:02.000",
            "sitearea_buscounting_minute.ActualArrivalDateTime": "2022-03-10T18:22:02.000",
            "sitearea_buscounting_minute.CompanyId": 12345,
            "sitearea_buscounting_minute.CompanyName": "Company1",
            "sitearea_buscounting_minute.BranchId": 11111,
            "sitearea_buscounting_minute.BranchName": "Branch1",
            "sitearea_buscounting_minute.AreaId": 1101,
            "sitearea_buscounting_minute.AreaName": "Area1",
            "sitearea_buscounting_minute.Time.minute": "2022-03-10T18:22:00.000",
            "sitearea_buscounting_minute.FC01_1_SUM": 3,
            "sitearea_buscounting_minute.FC02_1_SUM": 0,
            "sitearea_buscounting_minute.SO01_1_SUM": 5
        }
    ],
 
    ...
 
}

site_area_1d_joined_data

Description Site and Area data with different metrics
Cube Name
site_area_1d_joined_data
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'day'.

day, week, month, year
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. PFC01_11
  2. PFC02_11
  3. PFC01_3011
  4. PFC01_5011
  5. PFC27
  6. SWA04
  7. SWA05
  8. SWA06
  9. SWA07
  10. PWA01
  11. SWA02
Dimensions

Following fields can be used for applying filtering and ordering the data.

IMPORTANT: The only exception is Time. You may query for dimension Time, but when applying time filter, you should use StartDateFilter and EndDateFilter instead. Both of these columns have data type datetime as string. The returned results will be the data between these two times. 

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. StartDateFilter (datetime as string) (MUST BE USED AS FILTERS OVER TIME)
  3. EndDateFilter (datetime as string) (MUST BE USED AS FILTERS OVER TIME)
  4. OperateDate (datetime as string)
  5. IsOperating (string: "0" or "1")
  6. AreaId (string)
  7. AreaName (string)
  8. BranchId (string)
  9. BranchName (string)
  10. BranchCode (string)
  11. CompanyId (string)
  12. CompanyName (string)
  13. AreaGroupId (string)
  14. AreaGroupName (string)
  15. SiteGroupId (string)
  16. SiteGroupdName (string)
Segments

Available segments to filter data:

  1. IsAreaLevel - Use this segment to query area level data
  2. IsSiteLevel - Use this segment to query site level data

*Querying site level data without using IsSiteLevel may cause incorrect data returned.
Body - JSON Example
{
    "query": {
        "measures": [
            "site_area_1d_joined_data.PFC01_11",
            "site_area_1d_joined_data.PWA01",
            "site_area_1d_joined_data.SWA02",
            "site_area_1d_joined_data.PFC27",
            "site_area_1d_joined_data.SWA04",
            "site_area_1d_joined_data.SWA06"
        ],
        "dimensions": [
            "site_area_1d_joined_data.CompanyId",
            "site_area_1d_joined_data.CompanyName",
            "site_area_1d_joined_data.BranchId",
            "site_area_1d_joined_data.BranchName",
            "site_area_1d_joined_data.Time"
        ],
        "filters": [
            {
                "member": "site_area_1d_joined_data.BranchId",
                "operator": "equals",
                "values": [
                    "1"
                ]
            }, 
            {
                "member": "site_area_1d_joined_data.StartDateFilter",
                "operator": "equals",
                "values":  [
                    "2024-01-19"
                ]
            },
            {
                "member": "site_area_1d_joined_data.EndDateFilter",
                "operator": "equals",
                "values":  [
                    "2024-01-25"
                ]
            }
        ],
        "segments": [
            "site_area_1d_joined_data.IsSiteLevel"
        ],
        "order": {
            "site_area_1d_joined_data.Time": "asc"
        }
    }
}
Response - JSON Example
{
 
    ...
 
 
"data":
[
        {
            "site_area_1d_joined_data.CompanyId": 1,
            "site_area_1d_joined_data.CompanyName": "DemoCompany",
            "site_area_1d_joined_data.BranchId": 1,
            "site_area_1d_joined_data.BranchName": "Shoppingmall",
            "site_area_1d_joined_data.Time": "2024-01-19T00:00:00.000",
            "site_area_1d_joined_data.Time.day": "2024-01-19T00:00:00.000",
            "site_area_1d_joined_data.PFC01_11": 4958,
            "site_area_1d_joined_data.PWA01": 6060,
            "site_area_1d_joined_data.SWA02": 0.45,
            "site_area_1d_joined_data.PFC27": 1234.56,
            "site_area_1d_joined_data.SWA04": 0.66,
            "site_area_1d_joined_data.SWA06": 0.34
        },
        {
            "site_area_1d_joined_data.CompanyId": 1,
            "site_area_1d_joined_data.CompanyName": "DemoCompany",
            "site_area_1d_joined_data.BranchId": 1,
            "site_area_1d_joined_data.BranchName": "Shoppingmall",
            "site_area_1d_joined_data.Time": "2024-01-20T00:00:00.000",
            "site_area_1d_joined_data.Time.day": "2024-01-20T00:00:00.000",
            "site_area_1d_joined_data.PFC01_11": 4929,
            "site_area_1d_joined_data.PWA01": 7070,
            "site_area_1d_joined_data.SWA02": 0.41,
            "site_area_1d_joined_data.PFC27": 706.61,
            "site_area_1d_joined_data.SWA04": 0.21,
            "site_area_1d_joined_data.SWA06": 0.79
        }
  ],
 
    ...
 
}

site_area_1h_joined_data

Description Site and Area data with different metrics
Cube Name
site_area_1h_joined_data
Time granularities

The time granularity for this cube is 'hour'. Please use site_area_1d_joined_data for larger time granularities.
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. PFC01_11
  2. PFC02_11
  3. PFC01_3011
  4. PFC01_5011
  5. PFC27
  6. PWA01
  7. SWA02
Dimensions

Following fields can be used for applying filtering and ordering the data.

IMPORTANT: The only exception is Time. You may query for dimension Time, but when applying time filter, you should use StartDateFilter and EndDateFilter instead. Both of these columns have data type datetime as string. The returned results will be the data between these two times.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. StartDateFilter (datetime as string) (MUST BE USED AS FILTERS OVER TIME)
  3. EndDateFilter (datetime as string) (MUST BE USED AS FILTERS OVER TIME)
  4. OperateDate (datetime as string)
  5. IsOperating (string: "0" or "1")
  6. AreaId (string)
  7. AreaName (string)
  8. BranchId (string)
  9. BranchName (string)
  10. BranchCode (string)
  11. CompanyId (string)
  12. CompanyName (string)
  13. AreaGroupId (string)
  14. AreaGroupName (string)
  15. SiteGroupId (string)
  16. SiteGroupdName (string)
Segments

Available segments to filter data:

  1. IsAreaLevel - Use this segment to query area level data
  2. IsSiteLevel - Use this segment to query site level data

*Querying site level data without using IsSiteLevel may cause incorrect data returned.
Body - JSON Example
{
    "query": {
        "measures": [
            "site_area_1h_joined_data.PFC01_11",
            "site_area_1h_joined_data.PWA01",
            "site_area_1h_joined_data.SWA02",
            "site_area_1h_joined_data.PFC27"
        ],
        "dimensions": [
            "site_area_1h_joined_data.CompanyId",
            "site_area_1h_joined_data.CompanyName",
            "site_area_1h_joined_data.BranchId",
            "site_area_1h_joined_data.BranchName",
            "site_area_1h_joined_data.Time"
        ],
        "filters": [
            {
                "member": "site_area_1h_joined_data.BranchId",
                "operator": "equals",
                "values": [
                    "1"
                ]
            }, 
            {
                "member": "site_area_1h_joined_data.StartDateFilter",
                "operator": "equals",
                "values":  [
                    "2024-01-19"
                ]
            },
            {
                "member": "site_area_1h_joined_data.EndDateFilter",
                "operator": "equals",
                "values":  [
                    "2024-01-25"
                ]
            }
        ],
        "segments": [
            "site_area_1h_joined_data.IsSiteLevel"
        ],
        "order": {
            "site_area_1h_joined_data.Time": "asc"
        }
    }
}
Response - JSON Example
{
 
    ...
 
 
"data":
[
        {
            "site_area_1h_joined_data.CompanyId": 1,
            "site_area_1h_joined_data.CompanyName": "DemoCompany",
            "site_area_1h_joined_data.BranchId": 1,
            "site_area_1h_joined_data.BranchName": "Shoppingmall",
            "site_area_1h_joined_data.Time": "2024-01-19T10:00:00.000",
            "site_area_1h_joined_data.Time.hour": "2024-01-19T10:00:00.000",
            "site_area_1h_joined_data.PFC01_11": 325,
            "site_area_1h_joined_data.PWA01": 101,
            "site_area_1h_joined_data.SWA02": 0.76,
            "site_area_1h_joined_data.PFC27": 310.20
        },
        {
            "site_area_1h_joined_data.CompanyId": 18330,
            "site_area_1h_joined_data.CompanyName": "DemoCompany",
            "site_area_1h_joined_data.BranchId": 25610,
            "site_area_1h_joined_data.BranchName": "Shoppingmall",
            "site_area_1h_joined_data.Time": "2024-01-19T11:00:00.000",
            "site_area_1h_joined_data.Time.hour": "2024-01-19T11:00:00.000",
            "site_area_1h_joined_data.PFC01_11": 440,
            "site_area_1h_joined_data.PWA01": 202,
            "site_area_1h_joined_data.SWA02": 0.69,
            "site_area_1h_joined_data.PFC27": 322.21
        },
        ...
    ],
 
    ...
 
}

site_area_occupancy_data

Description Store site & area (space sense) occupancy data
Cube Name site_area_occupancy_data
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'second'.

second, minute, hour, day, week, month, year
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. PSO05_MIN
  2. PSO05_MAX
  3. PSO05_AVG
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (number)
  3. AreaName (string)
  4. BranchId (number)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (number)
  8. CompanyName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "site_area_occupancy_data.PSO05_MIN",
            "site_area_occupancy_data.PSO05_MAX",
            "site_area_occupancy_data.PSO05_AVG"
        ],
        "dimensions": [
          "site_area_occupancy_data.CompanyId",
          "site_area_occupancy_data.CompanyName",
          "site_area_occupancy_data.BranchId",
          "site_area_occupancy_data.BranchName",
          "site_area_occupancy_data.AreaId",
          "site_area_occupancy_data.AreaName"
        ],
        "filters": [
            {
                "member": "site_area_occupancy_data.CompanyId",
                "operator": "equals",
                "values": [
                    "12345"
                ]
            },
            {
                "member": "site_area_occupancy_data.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
            {
                "member": "site_area_occupancy_data.AreaId",
                "operator": "equals",
                "values": [
                    "33333"
                ]
            }
        ],
        "timeDimensions": [
            {
                "dimension": "site_area_occupancy_data.Time",
                "dateRange": [
                    "2022-01-01T00:00:00.000",
                    "2022-01-02"
                ],
                "granularity": "minute"
            }
        ],
        "order": [
            [
                "site_area_occupancy_data.BranchId",
                "asc"
            ],
            [
                "site_area_occupancy_data.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{


    ...


    "data": [
        {
            "site_area_occupancy_data.CompanyId": "12345",
            "site_area_occupancy_data.CompanyName": "DemoCompany",
            "site_area_occupancy_data.BranchId": "22222",
            "site_area_occupancy_data.BranchName": "DemoBranch",
            "site_area_occupancy_data.AreaId": "33333",
            "site_area_occupancy_data.AreaName": "DemoArea",
            "site_area_occupancy_data.Time.minute": "2022-01-01T00:00:00.000",
            "site_area_occupancy_data.Time": "2022-01-01T00:00:00.000",
            "site_area_occupancy_data.PSO05_MIN": 1,
            "site_area_occupancy_data.PSO05_MAX": 1,
            "site_area_occupancy_data.PSO05_AVG": 1
        },
        {
            "site_area_occupancy_data.CompanyId": "12345",
            "site_area_occupancy_data.CompanyName": "DemoCompany",
            "site_area_occupancy_data.BranchId": "22222",
            "site_area_occupancy_data.BranchName": "DemoBranch",
            "site_area_occupancy_data.AreaId": "33333",
            "site_area_occupancy_data.AreaName": "DemoArea",
            "site_area_occupancy_data.Time.minute": "2022-01-01T09:27:00.000",
            "site_area_occupancy_data.Time": "2022-01-01T09:27:00.000",
            "site_area_occupancy_data.PSO05_MIN": 0,
            "site_area_occupancy_data.PSO05_MAX": 1,
            "site_area_occupancy_data.PSO05_AVG": 0.6666666666666666
        },
        {
            "site_area_occupancy_data.CompanyId": "12345",
            "site_area_occupancy_data.CompanyName": "DemoCompany",
            "site_area_occupancy_data.BranchId": "22222",
            "site_area_occupancy_data.BranchName": "DemoBranch",
            "site_area_occupancy_data.AreaId": "33333",
            "site_area_occupancy_data.AreaName": "DemoArea",
            "site_area_occupancy_data.Time.minute": "2022-01-01T09:30:00.000",
            "site_area_occupancy_data.Time": "2022-01-01T09:30:00.000",
            "site_area_occupancy_data.PSO05_MIN": 0,
            "site_area_occupancy_data.PSO05_MAX": 2,
            "site_area_occupancy_data.PSO05_AVG": 1.2
        }
    ],


    ...


}

area_aggregate_occupancy_data_15m

Description Store site & area (in out) occupancy data
Cube Name area_aggregate_occupancy_data_15m
Time granularities

Following are available time granularities for this cube, minimum time granularity is 15 minutes (remain using 'minute' as the value for granularity parameter for the API).

minute, hour, day, week, month, year
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. PSO05_MIN
  2. PSO05_MAX
  3. PSO05_AVG
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (number)
  3. AreaName (string)
  4. BranchId (number)
  5. BranchName (string)
  6. CompanyId (number)
Body - JSON Example
{
    "query":
    {
        "measures": [
            "area_aggregate_occupancy_data_15m.PSO05_MIN",
            "area_aggregate_occupancy_data_15m.PSO05_MAX",
            "area_aggregate_occupancy_data_15m.PSO05_AVG"
        ],
        "dimensions": [
            "area_aggregate_occupancy_data_15m.CompanyId",
            "area_aggregate_occupancy_data_15m.CompanyName",
            "area_aggregate_occupancy_data_15m.BranchId",
            "area_aggregate_occupancy_data_15m.BranchName",
            "area_aggregate_occupancy_data_15m.AreaId",
            "area_aggregate_occupancy_data_15m.AreaName"
        ],
        "filters": [
            {
                "member": "area_aggregate_occupancy_data_15m.AreaId",
                "operator": "equals",
                "values": [
                    "333333"
                ]
            }
        ],
        "timeDimensions": [
            {
                "dimension": "area_aggregate_occupancy_data_15m.Time",
                "dateRange": [
                    "2024-01-01T00:00:00.000",
                    "2024-01-02"
                ],
                "granularity": "minute"
            }
        ],
        "order": [
            [
                "area_aggregate_occupancy_data_15m.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{


    ...


    "data": [
        {
            "site_area_occupancy_data.CompanyId": "12345",
            "site_area_occupancy_data.CompanyName": "DemoCompany",
            "site_area_occupancy_data.BranchId": "22222",
            "site_area_occupancy_data.BranchName": "DemoBranch",
            "site_area_occupancy_data.AreaId": "33333",
            "site_area_occupancy_data.AreaName": "DemoArea",
            "site_area_occupancy_data.Time.minute": "2022-01-01T00:00:00.000",
            "site_area_occupancy_data.Time": "2022-01-01T00:00:00.000",
            "site_area_occupancy_data.PSO05_MIN": 1,
            "site_area_occupancy_data.PSO05_MAX": 1,
            "site_area_occupancy_data.PSO05_AVG": 1
        },
        {
            "site_area_occupancy_data.CompanyId": "12345",
            "site_area_occupancy_data.CompanyName": "DemoCompany",
            "site_area_occupancy_data.BranchId": "22222",
            "site_area_occupancy_data.BranchName": "DemoBranch",
            "site_area_occupancy_data.AreaId": "33333",
            "site_area_occupancy_data.AreaName": "DemoArea",
            "site_area_occupancy_data.Time.minute": "2022-01-01T00:15:00.000",
            "site_area_occupancy_data.Time": "2022-01-01T00:15:00.000",
            "site_area_occupancy_data.PSO05_MIN": 0,
            "site_area_occupancy_data.PSO05_MAX": 1,
            "site_area_occupancy_data.PSO05_AVG": 0.6666666666666666
        },
        {
            "site_area_occupancy_data.CompanyId": "12345",
            "site_area_occupancy_data.CompanyName": "DemoCompany",
            "site_area_occupancy_data.BranchId": "22222",
            "site_area_occupancy_data.BranchName": "DemoBranch",
            "site_area_occupancy_data.AreaId": "33333",
            "site_area_occupancy_data.AreaName": "DemoArea",
            "site_area_occupancy_data.Time.minute": "2022-01-01T00:15:00.000",
            "site_area_occupancy_data.Time": "2022-01-01T00:15:00.000",
            "site_area_occupancy_data.PSO05_MIN": 0,
            "site_area_occupancy_data.PSO05_MAX": 2,
            "site_area_occupancy_data.PSO05_AVG": 1.2
        }
    ],


    ...


}

site_area_1h_queue_counting

Description Store site & area queue counting data
Cube Name
site_area_1h_queue_counting
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'hour'.

hour, day, week, month, year
Measures

Available metrics for this cube, refer Metrics Definition for metric details

  1. PQM01_MIN
  2. PQM01_MAX
  3. PQM01_AVG
  4. PQM01_SUM
  5. PQM03_MIN
  6. PQM03_MAX
  7. PQM03_AVG
  8. PQM03_SUM
  9. PQM04_MIN
  10. PQM04_MAX
  11. PQM04_AVG
  12. PQM04_SUM
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (number)
  3. AreaName (string)
  4. BranchId (number)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (number)
  8. CompanyName (string)
Body - JSON Example
{
     "query": {
     
      "measures": [
            "site_area_1h_queue_counting.PQM01_MIN",
            "site_area_1h_queue_counting.PQM01_MAX",
            "site_area_1h_queue_counting.PQM01_AVG",
            "site_area_1h_queue_counting.PQM01_SUM",
            "site_area_1h_queue_counting.PQM03_MIN",
            "site_area_1h_queue_counting.PQM03_MAX",
            "site_area_1h_queue_counting.PQM03_AVG",
            "site_area_1h_queue_counting.PQM03_SUM",
            "site_area_1h_queue_counting.PQM04_MIN",
            "site_area_1h_queue_counting.PQM04_MAX",
            "site_area_1h_queue_counting.PQM04_AVG",
            "site_area_1h_queue_counting.PQM04_SUM"
        ],
        "dimensions": [
            "site_area_1h_queue_counting.CompanyId",
            "site_area_1h_queue_counting.CompanyName",
            "site_area_1h_queue_counting.BranchId",
            "site_area_1h_queue_counting.BranchName",
            "site_area_1h_queue_counting.BranchCode",
            "site_area_1h_queue_counting.AreaId",
            "site_area_1h_queue_counting.AreaName",
            "site_area_1h_queue_counting.IsOperating",
            "site_area_1h_queue_counting.Time"
        ],
        "filters": [
            {
                "member": "site_area_1h_queue_counting.CompanyId",
                "operator": "equals",
                "values": [
                    "12345"
                ]
            },
            {
                "member": "site_area_1h_queue_counting.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
            {
                "member": "site_area_1h_queue_counting.AreaId",
                "operator": "equals",
                "values": [
                    "33333"
                ]
            }
        ],
        "timeDimensions": [
            {
                "dimension": "site_area_1h_queue_counting.Time",
                "dateRange": [
                    "2023-01-01T00:00:00.000",
                    "2023-01-02"
                ],
                "granularity": "minute"
            }
        ],
        "order": [
            [
                "site_area_1h_queue_counting.BranchId",
                "asc"
            ],
            [
                "site_area_1h_queue_counting.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{


    ...


 
"data": [
             
                {
                    "site_area_1h_queue_counting.CompanyId": 12345,
                    "site_area_1h_queue_counting.CompanyName": "DemoCompany",
                    "site_area_1h_queue_counting.BranchId": 22222,
                    "site_area_1h_queue_counting.BranchName": "DemoBranch",
                    "site_area_1h_queue_counting.BranchCode": "demo",
                    "site_area_1h_queue_counting.AreaId": 33333,
                    "site_area_1h_queue_counting.AreaName": "DemoArea",
                    "site_area_1h_queue_counting.IsOperating": 0,
                    "site_area_1h_queue_counting.Time": "2023-01-01T00:00:00.000",
                    "site_area_1h_queue_counting.PQM01_MIN": 6,
                    "site_area_1h_queue_counting.PQM01_MAX": 23,
                    "site_area_1h_queue_counting.PQM01_AVG": 19.3312,
                    "site_area_1h_queue_counting.PQM01_SUM": 23,
                    "site_area_1h_queue_counting.PQM03_MIN": 2,
                    "site_area_1h_queue_counting.PQM03_MAX": 23,
                    "site_area_1h_queue_counting.PQM03_AVG": 11.3434,
                    "site_area_1h_queue_counting.PQM03_SUM": 29,
                    "site_area_1h_queue_counting.PQM04_MIN": 2,
                    "site_area_1h_queue_counting.PQM04_MAX": 12,
                    "site_area_1h_queue_counting.PQM04_AVG": 11.2222,
                    "site_area_1h_queue_counting.PQM04_SUM": 12333
                },
                {
                 
                    "site_area_1h_queue_counting.CompanyId": 12345,
                    "site_area_1h_queue_counting.CompanyName": "DemoCompany",
                    "site_area_1h_queue_counting.BranchId": 22222,
                    "site_area_1h_queue_counting.BranchName": "DemoBranch",
                    "site_area_1h_queue_counting.BranchCode": "demo",
                    "site_area_1h_queue_counting.AreaId": 33333,
                    "site_area_1h_queue_counting.AreaName": "DemoArea",
                    "site_area_1h_queue_counting.IsOperating": 1,
                    "site_area_1h_queue_counting.Time": "2023-01-01T00:00:00.000",
                     "site_area_1h_queue_counting.PQM01_MIN": 0,
                    "site_area_1h_queue_counting.PQM01_MAX": 12,
                    "site_area_1h_queue_counting.PQM01_AVG": 14.433,
                    "site_area_1h_queue_counting.PQM01_SUM": 234,
                    "site_area_1h_queue_counting.PQM03_MIN": 1,
                    "site_area_1h_queue_counting.PQM03_MAX": 212,
                    "site_area_1h_queue_counting.PQM03_AVG": 12.3445,
                    "site_area_1h_queue_counting.PQM03_SUM": 123,
                    "site_area_1h_queue_counting.PQM04_MIN": 3,
                    "site_area_1h_queue_counting.PQM04_MAX": 33,
                    "site_area_1h_queue_counting.PQM04_AVG": 123,
                    "site_area_1h_queue_counting.PQM04_SUM": 1234
                }
    ],


    ...


}

site_area_1h_demographic_data

Description Store site & area demographic data
Cube Name
site_area_1h_demographic_data
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'hour'.

hour, day, week, month, year
Measures
  1. Gender_Male_SUM
  2. Gender_Female_SUM
  3. Emotion_Angry_SUM
  4. Emotion_Contempt_SUM
  5. Emotion_Disgust_SUM
  6. Emotion_Fear_SUM
  7. Emotion_Sad_SUM
  8. Emotion_Neutral_SUM
  9. Emotion_Happy_SUM
  10. Emotion_Surprised_SUM
  11. Children_Age
  12. Teenagers_Age
  13. Young_Adults_Age
  14. Middle_Aged_Adults_Age
  15. Elderly_Age
  16. Kids_And_Adults_Age
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (number)
  3. AreaName (string)
  4. BranchId (number)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (number)
  8. CompanyName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "site_area_1h_demographic_data.Gender_Male_SUM",
            "site_area_1h_demographic_data.Gender_Female_SUM",
            "site_area_1h_demographic_data.Emotion_Angry_SUM",
            "site_area_1h_demographic_data.Emotion_Contempt_SUM",
            "site_area_1h_demographic_data.Emotion_Disgust_SUM",
            "site_area_1h_demographic_data.Emotion_Fear_SUM",
            "site_area_1h_demographic_data.Emotion_Sad_SUM",
            "site_area_1h_demographic_data.Emotion_Neutral_SUM",
            "site_area_1h_demographic_data.Emotion_Happy_SUM",
            "site_area_1h_demographic_data.Emotion_Surprised_SUM",
            "site_area_1h_demographic_data.Children_Age",
            "site_area_1h_demographic_data.Teenagers_Age",
            "site_area_1h_demographic_data.Young_Adults_Age",
            "site_area_1h_demographic_data.Middle_Aged_Adults_Age",
            "site_area_1h_demographic_data.Elderly_Age",
            "site_area_1h_demographic_data.Kids_And_Adults_Age"
        ],
        "dimensions": [
            "site_area_1h_demographic_data.CompanyId",
            "site_area_1h_demographic_data.CompanyName",
            "site_area_1h_demographic_data.BranchId",
            "site_area_1h_demographic_data.BranchName",
            "site_area_1h_demographic_data.BranchCode",
            "site_area_1h_demographic_data.AreaId",
            "site_area_1h_demographic_data.AreaName",
            "site_area_1h_demographic_data.IsOperating",
            "site_area_1h_demographic_data.Time"
        ],
        "filters": [
            {
                "member": "site_area_1h_demographic_data.CompanyId",
                "operator": "equals",
                "values": [
                    "12345"
                ]
            },
            {
                "member": "site_area_1h_demographic_data.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
            {
                "member": "site_area_1h_demographic_data.AreaId",
                "operator": "equals",
                "values": [
                    "33333"
                ]
            }
        ],
        "timeDimensions": [
            {
                "dimension": "site_area_1h_demographic_data.Time",
                "dateRange": [
                    "2023-01-01T00:00:00.000",
                    "2023-01-02"
                ],
                "granularity": "minute"
            }
        ],
        "order": [
            [
                "site_area_1h_demographic_data.BranchId",
                "asc"
            ],
            [
                "site_area_1h_demographic_data.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{


    ...


 
"data": [
                {
                    "site_area_1h_demographic_data.CompanyId": 12345,
                    "site_area_1h_demographic_data.CompanyName": "DemoCompany",
                    "site_area_1h_demographic_data.BranchId": 22222,
                    "site_area_1h_demographic_data.BranchName": "DemoBranch",
                    "site_area_1h_demographic_data.AreaId": 33333,
                    "site_area_1h_demographic_data.AreaName": "DemoArea",
                    "site_area_1h_demographic_data.IsOperating": 1,
                    "site_area_1h_demographic_data.Time": "2023-01-01T00:00:00.000",
                    "site_area_1h_demographic_data.Gender_Male_SUM": 22,
                    "site_area_1h_demographic_data.Gender_Female_SUM": 13,
                    "site_area_1h_demographic_data.Emotion_Angry_SUM": 1,
                    "site_area_1h_demographic_data.Emotion_Contempt_SUM": 0,
                    "site_area_1h_demographic_data.Emotion_Disgust_SUM": 4,
                    "site_area_1h_demographic_data.Emotion_Fear_SUM": 2,
                    "site_area_1h_demographic_data.Emotion_Sad_SUM": 4,
                    "site_area_1h_demographic_data.Emotion_Neutral_SUM": 3,
                    "site_area_1h_demographic_data.Emotion_Happy_SUM": 2,
                    "site_area_1h_demographic_data.Emotion_Surprised_SUM": 5,
                    "site_area_1h_demographic_data.Children_Age": 4,
                    "site_area_1h_demographic_data.Teenagers_Age": 392,
                    "site_area_1h_demographic_data.Young_Adults_Age": 12,
                    "site_area_1h_demographic_data.Middle_Aged_Adults_Age": 14,
                    "site_area_1h_demographic_data.Elderly_Age": 2,
                    "site_area_1h_demographic_data.Kids_And_Adults_Age": 16
                },
                {
                    "site_area_1h_demographic_data.CompanyId": 12345,
                    "site_area_1h_demographic_data.CompanyName": "DemoCompany",
                    "site_area_1h_demographic_data.BranchId": 22222,
                    "site_area_1h_demographic_data.BranchName": "DemoBranch",
                    "site_area_1h_demographic_data.AreaId": 33333,
                    "site_area_1h_demographic_data.AreaName": "DemoArea",
                    "site_area_1h_demographic_data.IsOperating": 1,
                    "site_area_1h_demographic_data.Time": "2023-01-02T00:00:00.000",
                    "site_area_1h_demographic_data.Gender_Male_SUM": 14,
                    "site_area_1h_demographic_data.Gender_Female_SUM": 17,
                    "site_area_1h_demographic_data.Emotion_Angry_SUM": 0,
                    "site_area_1h_demographic_data.Emotion_Contempt_SUM": 3,
                    "site_area_1h_demographic_data.Emotion_Disgust_SUM": 2,
                    "site_area_1h_demographic_data.Emotion_Fear_SUM": 3,
                    "site_area_1h_demographic_data.Emotion_Sad_SUM": 3,
                    "site_area_1h_demographic_data.Emotion_Neutral_SUM": 4,
                    "site_area_1h_demographic_data.Emotion_Happy_SUM": 7,
                    "site_area_1h_demographic_data.Emotion_Surprised_SUM": 8,
                    "site_area_1h_demographic_data.Children_Age": 22,
                    "site_area_1h_demographic_data.Teenagers_Age": 12,
                    "site_area_1h_demographic_data.Young_Adults_Age": 78,
                    "site_area_1h_demographic_data.Middle_Aged_Adults_Age": 22,
                    "site_area_1h_demographic_data.Elderly_Age": 10,
                    "site_area_1h_demographic_data.Kids_And_Adults_Age": 100
                }
    ],


    ...


}

area_occupancy_live

Description Store site & area live occupancy count
Cube Name
area_occupancy_live
Time granularities

No time granularities needed for live data
Measures
  1. PSO05
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. AreaId (number)
  2. AreaName (string)
  3. BranchId (number)
  4. BranchName (string)
  5. CompanyId (number)
  6. CompanyName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "area_occupancy_live.PSO05"
        ],
        "dimensions": [
            "area_occupancy_live.CompanyId",
            "area_occupancy_live.CompanyName",
            "area_occupancy_live.BranchId",
            "area_occupancy_live.BranchName",
            "area_occupancy_live.AreaId",
            "area_occupancy_live.AreaName",
            "area_occupancy_live.AreaType"
        ],
        "filters": [
            {
                "member": "area_occupancy_live.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
            {
                "member": "area_occupancy_live.AreaId",
                "operator": "equals",
                "values": [
                    "33333",
                    "44444"
                ]
            }
        ], 
        "order": [
            [
                "area_occupancy_live.BranchId",
                "asc"
            ],
            [
                "area_occupancy_live.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{


    ...


 
"data": [
             
       {
            "area_occupancy_live.CompanyId": 12345,
            "area_occupancy_live.CompanyName": "DemoCompany",
            "area_occupancy_live.BranchId": 11111,
            "area_occupancy_live.BranchName": "DemoBranch",
            "area_occupancy_live.AreaId": 33333,
            "area_occupancy_live.AreaName": "DemoArea",
            "area_occupancy_live.AreaType": 1,
            "area_occupancy_live.PSO05": 5632
        },       
       {
            "area_occupancy_live.CompanyId": 12345,
            "area_occupancy_live.CompanyName": "DemoCompany",
            "area_occupancy_live.BranchId": 22222,
            "area_occupancy_live.BranchName": "DemoBranch",
            "area_occupancy_live.AreaId": 44444,
            "area_occupancy_live.AreaName": "DemoArea",
            "area_occupancy_live.AreaType": 1,
            "area_occupancy_live.PSO05": 2224
        }
 
    ],


    ...


}

site_area_1d_kid_counting_data

Description Store site & area kid & adult counting data
Cube Name
site_area_1d_kid_counting_data
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'day'.

day, week, month, year
Measures
  1. PFC01_3001
  2. PFC02_3001
  3. PFC01_5001
  4. PFC02_5001
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. AreaId (number)
  2. AreaName (string)
  3. BranchId (number)
  4. BranchName (string)
  5. CompanyId (number)
  6. CompanyName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "site_area_1d_kid_counting_data.PFC01_3001",
            "site_area_1d_kid_counting_data.PFC02_3001",
            "site_area_1d_kid_counting_data.PFC01_5001",
            "site_area_1d_kid_counting_data.PFC02_5001"
        ],
        "dimensions": [
            "site_area_1d_kid_counting_data.CompanyId",
            "site_area_1d_kid_counting_data.CompanyName",
            "site_area_1d_kid_counting_data.BranchId",
            "site_area_1d_kid_counting_data.BranchName",
            "site_area_1d_kid_counting_data.AreaId",
            "site_area_1d_kid_counting_data.AreaName",
            "site_area_1d_kid_counting_data.AreaType"
        ],
        "filters": [
            {
                "member": "site_area_1d_kid_counting_data.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
            {
                "member": "site_area_1d_kid_counting_data.AreaId",
                "operator": "equals",
                "values": [
                    "33333",
                    "44444"
                ]
            }
        ], 
        "order": [
            [
                "site_area_1d_kid_counting_data.BranchId",
                "asc"
            ],
            [
                "site_area_1d_kid_counting_data.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{


    ...


 
"data": [
             
       {
            "site_area_1d_kid_counting_data.CompanyId": 12345,
            "site_area_1d_kid_counting_data.CompanyName": "DemoCompany",
            "site_area_1d_kid_counting_data.BranchId": 11111,
            "site_area_1d_kid_counting_data.BranchName": "DemoBranch",
            "site_area_1d_kid_counting_data.AreaId": 33333,
            "site_area_1d_kid_counting_data.AreaName": "DemoArea",
            "site_area_1d_kid_counting_data.AreaType": 1,
            "site_area_1d_kid_counting_data.PFC01_3001": 5422,
            "site_area_1d_kid_counting_data.PFC02_3001": 5420,
            "site_area_1d_kid_counting_data.PFC01_5001": 12532,
            "site_area_1d_kid_counting_data.PFC02_5001": 12529 
        },       
       {
            "site_area_1d_kid_counting_data.CompanyId": 12345,
            "site_area_1d_kid_counting_data.CompanyName": "DemoCompany",
            "site_area_1d_kid_counting_data.BranchId": 22222,
            "site_area_1d_kid_counting_data.BranchName": "DemoBranch",
            "site_area_1d_kid_counting_data.AreaId": 44444,
            "site_area_1d_kid_counting_data.AreaName": "DemoArea",
            "site_area_1d_kid_counting_data.AreaType": 1,
            "site_area_1d_kid_counting_data.PFC01_3001": 5428,
            "site_area_1d_kid_counting_data.PFC02_3001": 5315,
            "site_area_1d_kid_counting_data.PFC01_5001": 35147,
            "site_area_1d_kid_counting_data.PFC02_5001": 32362
 
        }


    ],


    ...


}

site_area_1h_kid_counting_data

Description Store site & area kid & adult counting data
Cube Name
site_area_1h_kid_counting_data
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'hour'.

hour, day, week, month, year
Measures
  1. PFC01_3001
  2. PFC02_3001
  3. PFC01_5001
  4. PFC02_5001
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. AreaId (number)
  2. AreaName (string)
  3. BranchId (number)
  4. BranchName (string)
  5. CompanyId (number)
  6. CompanyName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "site_area_1h_kid_counting_data.PFC01_3001",
            "site_area_1h_kid_counting_data.PFC02_3001",
            "site_area_1h_kid_counting_data.PFC01_5001",
            "site_area_1h_kid_counting_data.PFC02_5001"
        ],
        "dimensions": [
            "site_area_1h_kid_counting_data.CompanyId",
            "site_area_1h_kid_counting_data.CompanyName",
            "site_area_1h_kid_counting_data.BranchId",
            "site_area_1h_kid_counting_data.BranchName",
            "site_area_1h_kid_counting_data.AreaId",
            "site_area_1h_kid_counting_data.AreaName",
            "site_area_1h_kid_counting_data.AreaType"
        ],
        "filters": [
            {
                "member": "site_area_1h_kid_counting_data.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
            {
                "member": "site_area_1h_kid_counting_data.AreaId",
                "operator": "equals",
                "values": [
                    "33333",
                    "44444"
                ]
            }
        ], 
        "order": [
            [
                "site_area_1h_kid_counting_data.BranchId",
                "asc"
            ],
            [
                "site_area_1h_kid_counting_data.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{


    ...


 
"data": [
             
       {
            "site_area_1h_kid_counting_data.CompanyId": 12345,
            "site_area_1h_kid_counting_data.CompanyName": "DemoCompany",
            "site_area_1h_kid_counting_data.BranchId": 11111,
            "site_area_1h_kid_counting_data.BranchName": "DemoBranch",
            "site_area_1h_kid_counting_data.AreaId": 33333,
            "site_area_1h_kid_counting_data.AreaName": "DemoArea",
            "site_area_1h_kid_counting_data.AreaType": 1,
            "site_area_1h_kid_counting_data.PFC01_3001": 5422,
            "site_area_1h_kid_counting_data.PFC02_3001": 5420,
            "site_area_1h_kid_counting_data.PFC01_5001": 12532,
            "site_area_1h_kid_counting_data.PFC02_5001": 12529 
        },       
       {
            "site_area_1h_kid_counting_data.CompanyId": 12345,
            "site_area_1h_kid_counting_data.CompanyName": "DemoCompany",
            "site_area_1h_kid_counting_data.BranchId": 22222,
            "site_area_1h_kid_counting_data.BranchName": "DemoBranch",
            "site_area_1h_kid_counting_data.AreaId": 44444,
            "site_area_1h_kid_counting_data.AreaName": "DemoArea",
            "site_area_1h_kid_counting_data.AreaType": 1,
            "site_area_1h_kid_counting_data.PFC01_3001": 5428,
            "site_area_1h_kid_counting_data.PFC02_3001": 5315,
            "site_area_1h_kid_counting_data.PFC01_5001": 35147,
            "site_area_1h_kid_counting_data.PFC02_5001": 32362
 
        }


    ],


    ...


}

site_area_wifi_counting_metric_day_data

Description Store site wifi counting data
Cube Name site_area_wifi_counting_metric_day_data
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'day'.

day, week, month, year
Measures

Available metrics for this cube

  1. PWA01
  2. SWA02
  3. PWA03
  4. SWA04
  5. SWA06
Dimensions

Following fields can be used for applying filtering and ordering the data. 

  1. Time (datetime as string) : Example "2021-10-01T00:00:00.000", "2021-10-03T00:00"
  2. BranchId (string)
  3. BranchName (string)
  4. CompanyId (string)
  5. CompanyName (string)
Body - JSON Examples
{
    "queryType": "multi",
    "query": {
        "measures": [
            "site_area_wifi_counting_metric_day_data.PWA01",
            "site_area_wifi_counting_metric_day_data.SWA02",
            "site_area_wifi_counting_metric_day_data.PWA03",
            "site_area_wifi_counting_metric_day_data.SWA04",
            "site_area_wifi_counting_metric_day_data.SWA06"
        ],
        "dimensions": [
            "site_area_wifi_counting_metric_day_data.Time",
            "site_area_wifi_counting_metric_day_data.BranchId",
            "site_area_wifi_counting_metric_day_data.BranchName",
            "site_area_wifi_counting_metric_day_data.CompanyId",
            "site_area_wifi_counting_metric_day_data.CompanyName"
        ],
"filters": [
            {
                "member": "site_area_wifi_counting_metric_day_data.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            }
        ], 
        "order": [
            [
                "site_area_wifi_counting_metric_day_data.BranchId",
                "asc"
            ],
            [
                "site_area_wifi_counting_metric_day_data.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON EXamples
{


    ...


 
"data": [
             
       {
            "site_area_wifi_counting_metric_day_data.Time": "2022-01-01T00:00:00.000",
            "site_area_wifi_counting_metric_day_data.BranchId": 11111,
            "site_area_wifi_counting_metric_day_data.BranchName": "DemoBranch",
            "site_area_wifi_counting_metric_day_data.CompanyId": 12345,
            "site_area_wifi_counting_metric_day_data.CompanyName": "DemoCompany",
            "site_area_wifi_counting_metric_day_data.PWA01": 204,
            "site_area_wifi_counting_metric_day_data.SWA02": 1.22,
            "site_area_wifi_counting_metric_day_data.PWA03": 23.12,
            "site_area_wifi_counting_metric_day_data.SWA04": 0.2367,
            "site_area_wifi_counting_metric_day_data.SWA06": 0.7633 
        },       
       {      
            "site_area_wifi_counting_metric_day_data.Time": "2022-01-02T00:00:00.000",
            "site_area_wifi_counting_metric_day_data.BranchId": 11111,
            "site_area_wifi_counting_metric_day_data.BranchName": "DemoBranch",
            "site_area_wifi_counting_metric_day_data.CompanyId": 12345,
            "site_area_wifi_counting_metric_day_data.CompanyName": "DemoCompany",
            "site_area_wifi_counting_metric_day_data.PWA01": 137,
            "site_area_wifi_counting_metric_day_data.SWA02": 4.16,
            "site_area_wifi_counting_metric_day_data.PWA03": 15.18,
            "site_area_wifi_counting_metric_day_data.SWA04": 0.1418,
            "site_area_wifi_counting_metric_day_data.SWA06": 0.8582 
        }


    ],


    ...


}

site_area_wifi_counting_metric_hour_data

Description Store site wifi counting data
Cube Name site_area_wifi_counting_metric_hour_data
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'hour'.

hour, day, week, month, year
Measures

Available metrics for this cube

  1. PWA01
  2. SWA02
Dimensions

Following fields can be used for applying filtering and ordering the data. 

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. BranchId (string)
  3. BranchName (string)
  4. CompanyId (string)
  5. CompanyName (string)
Body - JSON Examples
{
    "query": {
        "measures": [
            "site_area_wifi_counting_metric_hour_data.PWA01",
            "site_area_wifi_counting_metric_hour_data.SWA02"
        ],
        "dimensions": [
            "site_area_wifi_counting_metric_hour_data.Time",
            "site_area_wifi_counting_metric_hour_data.BranchId",
            "site_area_wifi_counting_metric_hour_data.BranchName",
            "site_area_wifi_counting_metric_hour_data.CompanyId",
            "site_area_wifi_counting_metric_hour_data.CompanyName"
        ],
"filters": [
            {
                "member": "site_area_wifi_counting_metric_hour_data.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            }
        ], 
        "order": [
            [
                "site_area_wifi_counting_metric_hour_data.BranchId",
                "asc"
            ],
            [
                "site_area_wifi_counting_metric_hour_data.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Examples
{


    ...


 
"data": [
             
   
       {
            "site_area_wifi_counting_metric_hour_data.Time": "2022-01-01T00:00:00.000",
            "site_area_wifi_counting_metric_hour_data.BranchId": 11111,
            "site_area_wifi_counting_metric_hour_data.BranchName": "DemoBranch",
            "site_area_wifi_counting_metric_hour_data.CompanyId": 12345,
            "site_area_wifi_counting_metric_hour_data.CompanyName": "DemoCompany",
            "site_area_wifi_counting_metric_hour_data.PWA01": 204,
            "site_area_wifi_counting_metric_hour_data.SWA02": 1.22
        },       
       {      
            "site_area_wifi_counting_metric_hour_data.Time": "2022-01-01T01:00:00.000",
            "site_area_wifi_counting_metric_hour_data.BranchId": 11111,
            "site_area_wifi_counting_metric_hour_data.BranchName": "DemoBranch",
            "site_area_wifi_counting_metric_hour_data.CompanyId": 12345,
            "site_area_wifi_counting_metric_hour_data.CompanyName": "DemoCompany",
            "site_area_wifi_counting_metric_hour_data.PWA01": 137,
            "site_area_wifi_counting_metric_hour_data.SWA02": 4.16
        }


    ],


    ...


}

site_1d_footfall_wifi_sales_data

Description Store daily footfall data
Cube Name site_1d_footfall_wifi_sales_data
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'day'.

day, week, month, year
Measures

Available metrics for this cube

  1. PFC01_11
  2. PFC27
  3. PWA01
  4. SWA02
  5. SWA04
  6. SWA06
Dimensions  

Following fields can be used for applying filtering and ordering the data. 

  1. Time (datetime as string) : Example "2021-10-01T00:00:00.000", "2021-10-01T00:00"
  2. BranchId (string)
  3. BranchName (string)
  4. CompanyId (string)
  5. CompanyName (string)
Body - JSON Examples
{
    "query": {
        "measures": [
            "site_1d_footfall_wifi_sales_data.PFC01_11",
            "site_1d_footfall_wifi_sales_data.PFC27",
            "site_1d_footfall_wifi_sales_data.PWA01",
            "site_1d_footfall_wifi_sales_data.SWA02",
            "site_1d_footfall_wifi_sales_data.SWA04",
            "site_1d_footfall_wifi_sales_data.SWA06"
        ],
        "dimensions": [
            "site_1d_footfall_wifi_sales_data.Time",
            "site_1d_footfall_wifi_sales_data.BranchId",
            "site_1d_footfall_wifi_sales_data.BranchName",
            "site_1d_footfall_wifi_sales_data.CompanyId",
            "site_1d_footfall_wifi_sales_data.CompanyName"
        ],
        "filters": [
            {
                "member": "site_1d_footfall_wifi_sales_data.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            }
        ], 
        "order": [
            [
                "site_1d_footfall_wifi_sales_data.BranchId",
                "asc"
            ],
            [
                "site_1d_footfall_wifi_sales_data.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Examples
{


    ...


 
"data": [
             
   
       {
            "site_1d_footfall_wifi_sales_data.Time": "2022-01-01T00:00:00.000",
            "site_1d_footfall_wifi_sales_data.BranchId": 11111,
            "site_1d_footfall_wifi_sales_data.BranchName": "DemoBranch",
            "site_1d_footfall_wifi_sales_data.CompanyId": 12345,
            "site_1d_footfall_wifi_sales_data.CompanyName": "DemoCompany",
            "site_1d_footfall_wifi_sales_data.PFC01_11": 2366,
            "site_1d_footfall_wifi_sales_data.PFC27": 1195.209,
            "site_1d_footfall_wifi_sales_data.PWA01": 649,
            "site_1d_footfall_wifi_sales_data.SWA02": 0.7847,
            "site_1d_footfall_wifi_sales_data.SWA04": 0.6124,
            "site_1d_footfall_wifi_sales_data.SWA06": 0.3876
        },       
       {      
            "site_1d_footfall_wifi_sales_data.Time": "2022-01-02T00:00:00.000",
            "site_1d_footfall_wifi_sales_data.BranchId": 11111,
            "site_1d_footfall_wifi_sales_data.BranchName": "DemoBranch",
            "site_1d_footfall_wifi_sales_data.CompanyId": 12345,
            "site_1d_footfall_wifi_sales_data.CompanyName": "DemoCompany",
            "site_1d_footfall_wifi_sales_data.PFC01_11": 2171,
            "site_1d_footfall_wifi_sales_data.PFC27": 937.0556,
            "site_1d_footfall_wifi_sales_data.PWA01": 861,
            "site_1d_footfall_wifi_sales_data.SWA02": 0.7160,
            "site_1d_footfall_wifi_sales_data.SWA04": 0.6106,
            "site_1d_footfall_wifi_sales_data.SWA06": 0.3894
        }


    ],


    ...


}

site_area_1h_customer_journeys

Description Store hourly customer journeys
Cube Name site_area_1h_customer_journeys
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'hour'.

hour, day, week, month, year
Measures

Available metrics for this cube

  1. JourneyCount
Dimensions  

Following fields can be used for applying filtering and ordering the data. 

  1. DateTime (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (string)
  3. AreaName (string)
  4. BranchId (string)
  5. BranchName (string)
  6. CompanyId (string)
  7. CompanyName
  8. Journey (string)
  9. JourneyIds (string)
Segments Following segments can be used to query the corresponding data based on the granularity needed. 
  1. IsAreaLevel ("true")
  2. IsSiteLevel ("true")
Body - JSON Exampels
{
    "query": {
        "measures": [
            "site_area_1h_customer_journeys.JourneyCount"
        ],
        "dimensions": [
            "site_area_1h_customer_journeys.DateTime",
            "site_area_1h_customer_journeys.AreaId",
            "site_area_1h_customer_journeys.AreaName",
            "site_area_1h_customer_journeys.BranchId",
            "site_area_1h_customer_journeys.BranchName",
            "site_area_1h_customer_journeys.CompanyId",
            "site_area_1h_customer_journeys.CompanyName",
            "site_area_1h_customer_journeys.Journey",
            "site_area_1h_customer_journeys.JourneyIds"
        ],
       "segments" : [
            "site_area_1h_customer_journeys.IsAreaLevel"
       ]
        "filters": [
            {
                "member": "site_area_1h_customer_journeys.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            }
        ], 
        "order": [
            [
                "site_area_1h_customer_journeys.BranchId",
                "asc"
            ],
            [
                "site_area_1h_customer_journeys.DateTime",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Examples
{


    ...


 
"data": [
             
   
       {
            "site_area_1h_customer_journeys.DateTime": "2022-01-01T00:00:00.000",
            "site_area_1h_customer_journeys.AreaId": 13131,
            "site_area_1h_customer_journeys.AreaName": "DemoArea",
            "site_area_1h_customer_journeys.BranchId": 11111,
            "site_area_1h_customer_journeys.BranchName": "DemoBranch",
            "site_area_1h_customer_journeys.CompanyId": 12345,
            "site_area_1h_customer_journeys.CompanyName": "DemoCompany",
            "site_area_1h_customer_journeys.Journey": "DemoZone2",
            "site_area_1h_customer_journeys.JourneyIds": "[2]", 
            "site_area_1h_customer_journeys.JourneyCount": 46
        },       
       {      
            "site_area_1h_customer_journeys.DateTime": "2022-01-01T00:00:00.000",
            "site_area_1h_customer_journeys.AreaId": 13131,
            "site_area_1h_customer_journeys.AreaName": "DemoArea",
            "site_area_1h_customer_journeys.BranchId": 11111,
            "site_area_1h_customer_journeys.BranchName": "DemoBranch",
            "site_area_1h_customer_journeys.CompanyId": 12345,
            "site_area_1h_customer_journeys.CompanyName": "DemoCompany",
            "site_area_1h_customer_journeys.Journey": "DemoZone1 -> DemoZone2",
            "site_area_1h_customer_journeys.JourneyIds": "[1,2]",
            "site_area_1h_customer_journeys.JourneyCount": 27
        }


    ],


    ...


}

site_area_1h_counting_data_ext

Description Store hourly counting data and dwell time
Cube Name site_area_1h_counting_data_ext
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'hour'.

hour, day, week, month, year
Measures

Available metrics for this cube

  1. FC01_11
  2. PFC27
Dimensions

Following fields can be used for applying filtering and ordering the data. 

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (string)
  3. AreaName (string)
  4. BranchId (string)
  5. BranchName (string)
  6. CompanyId (string)
  7. CompanyName (string)
Segments

Following segments can be used to query the corresponding data based on the granularity needed. 

  1. IsAreaLevel ("true")
  2. IsSiteLevel ("true")
Body - JSON Examples
{
    "query": {
        "measures": [
            "site_area_1h_counting_data_ext.FC01_11",
            "site_area_1h_counting_data_ext.PFC27"
        ],
        "dimensions": [
            "site_area_1h_counting_data_ext.Time",
            "site_area_1h_counting_data_ext.AreaId",
            "site_area_1h_counting_data_ext.AreaName",
            "site_area_1h_counting_data_ext.BranchId",
            "site_area_1h_counting_data_ext.BranchName",
            "site_area_1h_counting_data_ext.CompanyId",
            "site_area_1h_counting_data_ext.CompanyName"
        ],
"filters": [
            {
                "member": "site_area_1h_counting_data_ext.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            }
        ], 
        "order": [
            [
                "site_area_1h_counting_data_ext.BranchId",
                "asc"
            ],
            [
                "site_area_1h_counting_data_ext.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Examples
{


    ...


 
"data": [
             
   
       {
            "site_area_1h_counting_data_ext.Time": "2022-01-01T00:00:00.000",
            "site_area_1h_counting_data_ext.AreaId": 13131,
            "site_area_1h_counting_data_ext.AreaName": "DemoArea",
            "site_area_1h_counting_data_ext.BranchId": 11111,
            "site_area_1h_counting_data_ext.BranchName": "DemoBranch",
            "site_area_1h_counting_data_ext.CompanyId": 12345,
            "site_area_1h_counting_data_ext.CompanyName": "DemoCompany",
            "site_area_1h_counting_data_ext.FC01_11": 204,
            "site_area_1h_counting_data_ext.PFC27": 1320.34
        },       
       {      
            "site_area_1h_counting_data_ext.Time": "2022-01-01T01:00:00.000",
            "site_area_1h_counting_data_ext.AreaId": 13131,
            "site_area_1h_counting_data_ext.AreaName": "DemoArea",
            "site_area_1h_counting_data_ext.BranchId": 11111,
            "site_area_1h_counting_data_ext.BranchName": "DemoBranch",
            "site_area_1h_counting_data_ext.CompanyId": 12345,
            "site_area_1h_counting_data_ext.CompanyName": "DemoCompany",
            "site_area_1h_counting_data_ext.FC01_11": 137,
            "site_area_1h_counting_data_ext.PFC27": 1201.31
        }


    ],


    ...


}

area_1h_footfall_wifi_sales_data

Description Store hourly area footfall WiFi counting data
Cube Name area_1h_footfall_wifi_sales_data
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'hour'.

hour, day, week, month, year
Measures

Available metrics for this cube

  1. PFC01_11
  2. PFC27
  3. PFH05
Dimensions

Following fields can be used for applying filtering and ordering the data. 

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (string)
  3. AreaName (string)
  4. BranchId (string)
  5. BranchName (string)
  6. CompanyId (string)
  7. CompanyName (string)
  8. IsOperating (string)
Body - JSON Examples
{
    "query": {
        "measures": [
            "area_1h_footfall_wifi_sales_data.PFC01_11",
            "area_1h_footfall_wifi_sales_data.PFC27",
            "area_1h_footfall_wifi_sales_data.PFH05"
        ],
        "dimensions": [
            "area_1h_footfall_wifi_sales_data.Time",
            "area_1h_footfall_wifi_sales_data.AreaId",
            "area_1h_footfall_wifi_sales_data.AreaName",
            "area_1h_footfall_wifi_sales_data.BranchId",
            "area_1h_footfall_wifi_sales_data.BranchName",
            "area_1h_footfall_wifi_sales_data.CompanyId",
            "area_1h_footfall_wifi_sales_data.CompanyName",
            "area_1h_footfall_wifi_sales_data.IsOperating"
        ],
        "filters": [
            {
                "member": "area_1h_footfall_wifi_sales_data.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            }
        ], 
        "order": [
            [
                "area_1h_footfall_wifi_sales_data.BranchId",
                "asc"
            ],
            [
                "area_1h_footfall_wifi_sales_data.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Examples
{


    ...


 
"data": [
             
   
       {
            "area_1h_footfall_wifi_sales_data.Time": "2022-01-01T00:00:00.000",
            "area_1h_footfall_wifi_sales_data.AreaId": 13131,
            "area_1h_footfall_wifi_sales_data.AreaName": "DemoArea",
            "area_1h_footfall_wifi_sales_data.BranchId": 11111,
            "area_1h_footfall_wifi_sales_data.BranchName": "DemoBranch",
            "area_1h_footfall_wifi_sales_data.CompanyId": 12345,
            "area_1h_footfall_wifi_sales_data.CompanyName": "DemoCompany",
            "area_1h_footfall_wifi_sales_data.IsOperating": 1,
            "area_1h_footfall_wifi_sales_data.PFC01_11": 204,
            "area_1h_footfall_wifi_sales_data.PFC27": 1320.34,
            "area_1h_footfall_wifi_sales_data.PFH05": 19.7288
        },       
       {      
            "area_1h_footfall_wifi_sales_data.Time": "2022-01-01T01:00:00.000",
            "area_1h_footfall_wifi_sales_data.AreaId": 13131,
            "area_1h_footfall_wifi_sales_data.AreaName": "DemoArea",
            "area_1h_footfall_wifi_sales_data.BranchId": 11111,
            "area_1h_footfall_wifi_sales_data.BranchName": "DemoBranch",
            "area_1h_footfall_wifi_sales_data.CompanyId": 12345,
            "area_1h_footfall_wifi_sales_data.CompanyName": "DemoCompany",
            "area_1h_footfall_wifi_sales_data.IsOperating": 0,
            "area_1h_footfall_wifi_sales_data.PFC01_11": 137,
            "area_1h_footfall_wifi_sales_data.PFC27": 1201.31,
            "area_1h_footfall_wifi_sales_data.PFH05": 21.4473
        }


    ],


    ...


}

area_1h_footfall_wifi_sales_data_new

Description Store hourly area footfall WiFi counting data
Cube Name area_1h_footfall_wifi_sales_data_new
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'hour'.

hour, day, week, month, year
Measures

Available metrics for this cube

  1. VisitorIn
Dimensions

Following fields can be used for applying filtering and ordering the data. 

  1. __time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (string)
  3. AreaName (string)
  4. BranchId (string)
  5. BranchName (string)
  6. CompanyId (string)
  7. CompanyName (string)
  8. Dwelltime (float as string)
  9. IsOperating (string)
Body - JSON Examples
{
    "query": {
        "measures": [
            "area_1h_footfall_wifi_sales_data_new.VisitorIn"
        ],
        "dimensions": [
            "area_1h_footfall_wifi_sales_data_new.__time",
            "area_1h_footfall_wifi_sales_data_new.AreaId",
            "area_1h_footfall_wifi_sales_data_new.AreaName",
            "area_1h_footfall_wifi_sales_data_new.BranchId",
            "area_1h_footfall_wifi_sales_data_new.BranchName",
            "area_1h_footfall_wifi_sales_data_new.CompanyId",
            "area_1h_footfall_wifi_sales_data_new.CompanyName",
            "area_1h_footfall_wifi_sales_data_new.Dwelltime",
            "area_1h_footfall_wifi_sales_data_new.IsOperating"
        ],
        "filters": [
            {
                "member": "area_1h_footfall_wifi_sales_data_new.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            }
        ], 
        "order": [
            [
                "area_1h_footfall_wifi_sales_data_new.BranchId",
                "asc"
            ],
            [
                "area_1h_footfall_wifi_sales_data_new.__time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Examples
{


    ...


 
"data": [
             
   
       {
            "area_1h_footfall_wifi_sales_data_new.__time": "2022-01-01T00:00:00.000",
            "area_1h_footfall_wifi_sales_data_new.AreaId": 13131,
            "area_1h_footfall_wifi_sales_data_new.AreaName": "DemoArea",
            "area_1h_footfall_wifi_sales_data_new.BranchId": 11111,
            "area_1h_footfall_wifi_sales_data_new.BranchName": "DemoBranch",
            "area_1h_footfall_wifi_sales_data_new.CompanyId": 12345,
            "area_1h_footfall_wifi_sales_data_new.CompanyName": "DemoCompany",
            "area_1h_footfall_wifi_sales_data_new.VisitorIn": 204,
            "area_1h_footfall_wifi_sales_data_new.Dwelltime": 1320.34,
            "area_1h_footfall_wifi_sales_data_new.IsOperating": 1
        },       
       {      
            "area_1h_footfall_wifi_sales_data_new.__time": "2022-01-01T01:00:00.000",
            "area_1h_footfall_wifi_sales_data_new.AreaId": 13131,
            "area_1h_footfall_wifi_sales_data_new.AreaName": "DemoArea",
            "area_1h_footfall_wifi_sales_data_new.BranchId": 11111,
            "area_1h_footfall_wifi_sales_data_new.BranchName": "DemoBranch",
            "area_1h_footfall_wifi_sales_data_new.CompanyId": 12345,
            "area_1h_footfall_wifi_sales_data_new.CompanyName": "DemoCompany",
            "area_1h_footfall_wifi_sales_data_new.VisitorIn": 137,
            "area_1h_footfall_wifi_sales_data_new.Dwelltime": 1201.31,
            "area_1h_footfall_wifi_sales_data_new.IsOperating": 0
        }


    ],


    ...


}

customer_journeys

Description Store customer journeys
Cube Name customer_journeys
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'second'.

second, minute, hour, day, week, month, year
Measures

Available metrics for this cube

  1. Count
Dimensions

Following fields can be used for applying filtering and ordering the data. 

  1. DateTime (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. BranchId (string)
  3. CompanyId (string)
  4. IsOperating (string)
  5. Journey (string)
  6. JourneyIds (string)
Body - JSON Examples
{
    "query": {
        "measures": [
            "customer_journeys.Count"
        ],
        "dimensions": [
            "customer_journeys.DateTime",
            "customer_journeys.BranchId",
            "customer_journeys.CompanyId",
            "customer_journeys.IsOperating",
            "customer_journeys.Journey",
            "customer_journeys.JourneyIds"
        ],
        "filters": [
            {
                "member": "customer_journeys.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            }
        ], 
        "order": [
            [
                "customer_journeys.BranchId",
                "asc"
            ],
            [
                "customer_journeys.DateTime",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Examples
{


    ...


 
"data": [
             
   
       {
            "customer_journeys.Time": "2022-01-01T00:00:00.000",
            "customer_journeys.BranchId": 11111,
            "customer_journeys.CompanyId": 12345,
            "customer_journeys.IsOperating": 1,
            "customer_journeys.Journey": "Cashier",
            "customer_journeys.JourneyIds": "[1]",
            "customer_journeys.Count": 1
        },       
       {      
            "customer_journeys.Time": "2022-01-01T01:00:00.000",
            "customer_journeys.BranchId": 11111,
            "customer_journeys.CompanyId": 12345,
            "customer_journeys.IsOperating": 0,
            "customer_journeys.Journey": "Fridge A -> Cashier",
            "customer_journeys.JourneyIds": "[2]",
            "customer_journeys.Count": 2
        }


    ],


    ...


}

site_1h_footfall_wifi_sales_data

Description Store hourly footfall data
Cube Name site_1h_footfall_wifi_sales_data
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'hour'.

hour, day, week, month, year
Measures

Available metrics for this cube

  1. PFC01_11
  2. PFC27
  3. PWA01
  4. SWA02
Dimensions

Following fields can be used for applying filtering and ordering the data. 

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. BranchId (string)
  3. BranchName (string)
  4. CompanyId (string)
  5. CompanyName (string)
Body - JSON Examples
{
    "query": {
        "measures": [
            "site_1h_footfall_wifi_sales_data.PFC01_11",
            "site_1h_footfall_wifi_sales_data.PFC27",
            "site_1h_footfall_wifi_sales_data.PWA01",
            "site_1h_footfall_wifi_sales_data.SWA02"
        ],
        "dimensions": [
            "site_1h_footfall_wifi_sales_data.Time",
            "site_1h_footfall_wifi_sales_data.BranchId",
            "site_1h_footfall_wifi_sales_data.BranchName",
            "site_1h_footfall_wifi_sales_data.CompanyId",
            "site_1h_footfall_wifi_sales_data.CompanyName"
        ],
        "filters": [
            {
                "member": "site_1h_footfall_wifi_sales_data.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            }
        ], 
        "order": [
            [
                "site_1h_footfall_wifi_sales_data.BranchId",
                "asc"
            ],
            [
                "site_1h_footfall_wifi_sales_data.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Examples
{


    ...


 
"data": [
             
   
       {
            "site_1h_footfall_wifi_sales_data.Time": "2022-01-01T00:00:00.000",
            "site_1h_footfall_wifi_sales_data.BranchId": 11111,
            "site_1h_footfall_wifi_sales_data.BranchName": "DemoBranch",
            "site_1h_footfall_wifi_sales_data.CompanyId": 12345,
            "site_1h_footfall_wifi_sales_data.CompanyName": "DemoCompany",
            "site_1h_footfall_wifi_sales_data.PFC01_11": 204,
            "site_1h_footfall_wifi_sales_data.PFC27": 1320.34,
            "site_1h_footfall_wifi_sales_data.PWA01": 649,
            "site_1h_footfall_wifi_sales_data.SWA02": 0.7847
        },       
       {      
            "site_1h_footfall_wifi_sales_data.Time": "2022-01-01T01:00:00.000",
            "site_1h_footfall_wifi_sales_data.BranchId": 11111,
            "site_1h_footfall_wifi_sales_data.BranchName": "DemoBranch",
            "site_1h_footfall_wifi_sales_data.CompanyId": 12345,
            "site_1h_footfall_wifi_sales_data.CompanyName": "DemoCompany",
            "site_1h_footfall_wifi_sales_data.PFC01_11": 2171,
            "site_1h_footfall_wifi_sales_data.PFC27": 937.0556,
            "site_1h_footfall_wifi_sales_data.PWA01": 861,
            "site_1h_footfall_wifi_sales_data.SWA02": 0.7160
        }


    ],


    ...


}

site_1h_counting_prediction

Description

Hourly historical footfall and predicted footfall for 14-day before and after the input date. For past dates, historical footfall and predicted footfall are returned to compare the accuracy. For future dates, only predicted footfall are returned, historical footfall are unknown.

56-day hourly historical data (minimum 14 days) are used to predict the next 14-day hourly footfall.
Cube Name site_1h_counting_prediction
Time Granularities Hour
Measures

Available metrics for this cube:

  1. PFC01
  2. PFC01 Prediction (PFC23)
Dimensions

Following fields can be used for applying filtering and ordering the data. 

  1. CompanyId (number)
  2. BranchId (string)
  3. BranchName (string)
  4. DayOfWeek (number)
  5. Time (datetime as string): Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  6. StartDateTime (datetime as string)
  7. CurrentLocalTime (datetime as string)
  8. IsOperating (string)
Body - JSON Examples
{
    "query": {
        "dimensions": [
            "site_1h_counting_prediction.CompanyId",
            "site_1h_counting_prediction.BranchId",
            "site_1h_counting_prediction.BranchName",
            "site_1h_counting_prediction.DayOfWeek",
            "site_1h_counting_prediction.Time",
            "site_1h_counting_prediction.StartDateTime",
            "site_1h_counting_prediction.CurrentLocalTime",
            "site_1h_counting_prediction.IsOperating",
            "site_1h_counting_prediction.PFC01",
            "site_1h_counting_prediction.PFC01_Prediction"
        ],
        "filters": [
            {
                "member": "site_1h_counting_prediction.BranchId",
                "operator": "equals",
                "values": [
                    "11111"
                ]
            },
            {
                "member": "site_1h_counting_prediction.StartDateTime",
                "operator": "equals",
                "values": [
                    "2024-03-11"
                ]
            },
            {
                "member": "site_1h_counting_prediction.IsOperating",
                "operator": "equals",
                "values": [
                    "1"
                ]
            }
        ],
        "order": [
            [
                "site_1h_counting_prediction.Time",
                "asc"
            ]
        ],
        "limit": 50000,
        "renewQuery": "TRUE"
    }
}
Response - JSON Examples
{


    ...


 
"data": [
        {
            "site_1h_counting_prediction.CompanyId": 12345,
            "site_1h_counting_prediction.BranchId": 11111,
            "site_1h_counting_prediction.BranchName": "DemoBranch",
            "site_1h_counting_prediction.DayOfWeek": 1,
            "site_1h_counting_prediction.Time": "2024-02-26T09:00:00.000",
            "site_1h_counting_prediction.StartDateTime": "2024-03-11T00:00:00.000",
            "site_1h_counting_prediction.CurrentLocalTime": "2024-03-11T16:05:58.000",
            "site_1h_counting_prediction.IsOperating": "1",
            "site_1h_counting_prediction.PFC01": 7,
            "site_1h_counting_prediction.PFC01_Prediction": 24
        },
 
       ...
       {
            "site_1h_counting_prediction.CompanyId": 12345,
            "site_1h_counting_prediction.BranchId": 11111,
            "site_1h_counting_prediction.BranchName": "DemoBranch",
            "site_1h_counting_prediction.DayOfWeek": 1,
            "site_1h_counting_prediction.Time": "2024-03-11T09:00:00.000",
            "site_1h_counting_prediction.StartDateTime": "2024-03-11T00:00:00.000",
            "site_1h_counting_prediction.CurrentLocalTime": "2024-03-11T16:05:58.000",
            "site_1h_counting_prediction.IsOperating": "1",
            "site_1h_counting_prediction.PFC01": 22,
            "site_1h_counting_prediction.PFC01_Prediction": 15
        },
 
         ...
     
        {
            "site_1h_counting_prediction.CompanyId": 12345,
            "site_1h_counting_prediction.BranchId": 11111,
            "site_1h_counting_prediction.BranchName": "DemoBranch",
            "site_1h_counting_prediction.DayOfWeek": 7,
            "site_1h_counting_prediction.Time": "2024-03-24T18:00:00.000",
            "site_1h_counting_prediction.StartDateTime": "2024-03-11T00:00:00.000",
            "site_1h_counting_prediction.CurrentLocalTime": "2024-03-11T16:05:58.000",
            "site_1h_counting_prediction.IsOperating": "1",
            "site_1h_counting_prediction.PFC01": null,
            "site_1h_counting_prediction.PFC01_Prediction": 288
        }
    ],


    ...


}

site_1d_summary

Description Store site daily level data
Cube Name site_1d_summary
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'minute'.

day, week, month, year
Measures

Available metrics for this cube

  1. A01
  2. A02
  3. A03
  4. A04
  5. A05
  6. B01
  7. B03
  8. P01
  9. P23
  10. P25
Dimensions

The following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (number) (Only works for main entrance area)
  3. AreaName (string)
  4. BranchId (number)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (number)
  8. CompanyName (string)
  9. OperateDate (datetime as string)
  10. IsWeekDay (number)
  11. IsPublicHoliday (number)
Body - JSON Example
{
    "query": {
        "measures": [
            "site_1d_summary.A01",
            "site_1d_summary.A02",
            "site_1d_summary.A03",
            "site_1d_summary.A04",
            "site_1d_summary.A05",
            "site_1d_summary.B01",
            "site_1d_summary.B03"
        ],
        "dimensions": [
            "site_1d_summary.CompanyId",
            "site_1d_summary.CompanyName",
            "site_1d_summary.BranchId",
            "site_1d_summary.BranchName"
        ],
        "filters": [
            {
                "member": "site_1d_summary.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
            {
                "member": "site_1d_summary.IsWeekday",
                "operator": "equals",
                "values": [
                    "true"
                ]
            },
        ],
        "timeDimensions": [
            {
                "dimension": "site_1d_summary.Time",
                "dateRange": [
                    "2024-01-01T00:00:00.000",
                    "2024-01-31T23:59:59.000"
                ],
                "granularity": "day"
            }
        ],
        "order": [
            [
                "site_1d_summary.BranchId",
                "asc"
            ],
            [
                "site_1d_summary.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "site_1d_summary.CompanyId": "12345",
            "site_1d_summary.CompanyName": "DemoCompany",
            "site_1d_summary.BranchId": "11111",
            "site_1d_summary.BranchName": "DemoBranch",
            "site_1d_summary.Time.day": "2024-01-01T00:00:00.000",
            "site_1d_summary.A01": 4958,
            "site_1d_summary.A02": 6060,
            "site_1d_summary.A03": 241,
            "site_1d_summary.A04": 376.42,
            "site_1d_summary.A05": 5839,
            "site_1d_summary.B01": 0.4592,
            "site_1d_summary.B03": 0.3213,
        },
        {
            "site_1d_summary.CompanyId": "12345",
            "site_1d_summary.CompanyName": "DemoCompany",
            "site_1d_summary.BranchId": "11111",
            "site_1d_summary.BranchName": "DemoBranch",
            "site_1d_summary.Time.day": "2024-01-02T00:00:00.000",
            "site_1d_summary.A01": 2345,
            "site_1d_summary.A02": 1234,
            "site_1d_summary.A03": 132,
            "site_1d_summary.A04": 256.23,
            "site_1d_summary.A05": 4531,
            "site_1d_summary.B01": 0.3410,
            "site_1d_summary.B03": 0.1253,
        },
    ],
 
    ...
 
}

site_1h_summary

Description Store site hourly level data
Cube Name site_1h_summary
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'hour'.

hour, day, week, month, year
Measures

Available metrics for this cube

  1. A01
  2. A02
  3. A03
  4. A04
  5. A05
  6. B01
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (number) (Only works for main entrance)
  3. AreaName (string)
  4. BranchId (number)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (number)
  8. CompanyName (string)
  9. OperateDate (datetime as string)
  10. IsWeekDay (number)
  11. IsPublicHoliday (number)
Body - JSON Example
{
    "query": {
        "measures": [
            "site_1h_summary.A01",
            "site_1h_summary.A02",
            "site_1h_summary.A03",
            "site_1h_summary.A04",
            "site_1h_summary.A05",
            "site_1h_summary.B01"
        ],
        "dimensions": [
            "site_1h_summary.CompanyId",
            "site_1h_summary.CompanyName",
            "site_1h_summary.BranchId",
            "site_1h_summary.BranchName"
        ],
        "filters": [
            {
                "member": "site_1h_summary.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
            {
                "member": "site_1h_summary.IsWeekday",
                "operator": "equals",
                "values": [
                    "true"
                ]
            },
        ],
        "timeDimensions": [
            {
                "dimension": "site_1h_summary.Time",
                "dateRange": [
                    "2024-01-01T00:00:00.000",
                    "2024-01-31T23:59:59.000"
                ],
                "granularity": "hour"
            }
        ],
        "order": [
            [
                "site_1h_summary.BranchId",
                "asc"
            ],
            [
                "site_1h_summary.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "site_1h_summary.CompanyId": "12345",
            "site_1h_summary.CompanyName": "DemoCompany",
            "site_1h_summary.BranchId": "11111",
            "site_1h_summary.BranchName": "DemoBranch",
            "site_1h_summary.Time.hour": "2024-01-01T00:00:00.000",
            "site_1h_summary.A01": 4958,
            "site_1h_summary.A02": 6060,
            "site_1h_summary.A03": 241,
            "site_1h_summary.A04": 376.42,
            "site_1h_summary.A05": 5839,
            "site_1h_summary.B01": 0.4592,
            "site_1h_summary.B03": 0.3213,
        },
        {
            "site_1h_summary.CompanyId": "12345",
            "site_1h_summary.CompanyName": "DemoCompany",
            "site_1h_summary.BranchId": "11111",
            "site_1h_summary.BranchName": "DemoBranch",
            "site_1h_summary.Time.hour": "2024-01-01T01:00:00.000",
            "site_1h_summary.A01": 2345,
            "site_1h_summary.A02": 1234,
            "site_1h_summary.A03": 132,
            "site_1h_summary.A04": 256.23,
            "site_1h_summary.A05": 4531,
            "site_1h_summary.B01": 0.3410,
            "site_1h_summary.B03": 0.1253,
        },
    ],
 
    ...
 
}

site_1m_summary

Description Store site minute level data
Cube Name site_1m_summary
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'minute'.

minute, hour, day, week, month, year
Measures

Available metrics for this cube

  1. A01
  2. A02
  3. A03
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. Time15Minute (datetime as string). Use this instead of Time to filter for 15 minutes of granularity
  3. AreaId (number)
  4. AreaName (string)
  5. BranchId (number)
  6. BranchCode (string)
  7. BranchName (string)
  8. CompanyId (number)
  9. CompanyName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "site_1m_summary.A01",
            "site_1m_summary.A02",
            "site_1m_summary.A03"
        ],
        "dimensions": [
            "site_1m_summary.CompanyId",
            "site_1m_summary.CompanyName",
            "site_1m_summary.BranchId",
            "site_1m_summary.BranchName"
        ],
        "filters": [
            {
                "member": "site_1m_summary.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
        ],
        "timeDimensions": [
            {
                "dimension": "site_1m_summary.Time",
                "dateRange": [
                    "2024-01-01T00:00:00.000",
                    "2024-01-01T23:59:59.000"
                ],
                "granularity": "minute"
            }
        ],
        "order": [
            [
                "site_1m_summary.BranchId",
                "asc"
            ],
            [
                "site_1m_summary.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "site_1m_summary.CompanyId": "12345",
            "site_1m_summary.CompanyName": "DemoCompany",
            "site_1m_summary.BranchId": "11111",
            "site_1m_summary.BranchName": "DemoBranch",
            "site_1m_summary.Time.minute": "2024-01-01T00:00:00.000",
            "site_1m_summary.A01": 3,
            "site_1m_summary.A02": 5,
            "site_1m_summary.A03": 81
        },
        {
            "site_1m_summary.CompanyId": "12345",
            "site_1m_summary.CompanyName": "DemoCompany",
            "site_1m_summary.BranchId": "11111",
            "site_1m_summary.BranchName": "DemoBranch",
            "site_1m_summary.Time.minute": "2024-01-01T00:01:00.000",
            "site_1m_summary.A01": 5,
            "site_1m_summary.A02": 2,
            "site_1m_summary.A03": 52
        },
    ],
 
    ...
 
}

site_live_summary

Description Store site level live data
Cube Name site_live_summary
Measures

Available metrics for this cube

  1. A03
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. AreaId (number)
  2. AreaName (string)
  3. BranchId (number)
  4. BranchCode (string)
  5. BranchName (string)
  6. CompanyId (number)
  7. CompanyName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "site_live_summary.A03"
        ],
        "dimensions": [
            "site_live_summary.CompanyId",
            "site_live_summary.CompanyName",
            "site_live_summary.BranchId",
            "site_live_summary.BranchName"
        ],
        "filters": [
            {
                "member": "site_live_summary.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
        ],
        "order": [
            [
                "site_live_summary.BranchId",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "site_live_summary.CompanyId": "12345",
            "site_live_summary.CompanyName": "DemoCompany",
            "site_live_summary.BranchId": "11111",
            "site_live_summary.BranchName": "DemoBranch",
            "site_live_summary.A03": 81
        },
        {
            "site_live_summary.CompanyId": "12345",
            "site_live_summary.CompanyName": "DemoCompany",
            "site_live_summary.BranchId": "22222",
            "site_live_summary.BranchName": "DemoBranch2",
            "site_live_summary.A03": 52
        },
    ],
 
    ...
 
}

site_1x_prediction

Description Store site level prediction data
Cube Name site_1m_prediction, site_1h_prediction, site_1d_prediction, site_1m_prediction
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'minute'.

minute, hour, day, month
Measures

Available metrics for this cube

  1. A03Capacity
  2. P03
  3. P21
  4. P22
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (number)
  3. AreaName (string)
  4. BranchId (number)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (number)
  8. CompanyName (string)
  9. AreaGroupId (number)
  10. AreaGroupName (string)
  11. AreaTypeId (number)
  12. AreaTypeName (string)
  13. SiteGroupId (number)
  14. SiteGroupName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "site_1h_prediction.P03"
        ],
        "dimensions": [
            "site_1h_prediction.CompanyId",
            "site_1h_prediction.CompanyName",
            "site_1h_prediction.BranchId",
            "site_1h_prediction.BranchName"
        ],
        "filters": [
            {
                "member": "site_1h_prediction.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            }
        ],
        "timeDimensions": [
            {
                "dimension": "site_1h_prediction.Time",
                "dateRange": [
                    "2024-01-01T00:00:00.000",
                    "2024-01-01T23:59:59.000"
                ],
                "granularity": "hour"
            }
         ],
        "order": [
            [
                "site_1h_prediction.BranchId",
                "asc"
            ],
            [
                "site_1h_prediction.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "site_today_summary.CompanyId": "12345",
            "site_today_summary.CompanyName": "DemoCompany",
            "site_today_summary.BranchId": "11111",
            "site_today_summary.BranchName": "DemoBranch",
            "site_today_summary.Time.minute": "2024-01-01T00:00:00.000",
            "site_today_summary.P03": 104
        },
        {
            "site_today_summary.CompanyId": "12345",
            "site_today_summary.CompanyName": "DemoCompany",
            "site_today_summary.BranchId": "11111",
            "site_today_summary.BranchName": "DemoBranch",
            "site_today_summary.Time.minute": "2024-01-01T00:01:00.000",
            "site_today_summary.A03": 152
        },
    ],
 
    ...
 
}

site_today_summary

Description Store today's site level data
Cube Name site_today_summary
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'minute'.

minute, hour, day
Measures

Available metrics for this cube

  1. A03
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. Time1Hour (datetime as string). Use this instead of Time to filter for 1 hour of granularity
  3. AreaId (number)
  4. AreaName (string)
  5. BranchId (number)
  6. BranchCode (string)
  7. BranchName (string)
  8. CompanyId (number)
  9. CompanyName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "site_today_summary.A03"
        ],
        "dimensions": [
            "site_today_summary.CompanyId",
            "site_today_summary.CompanyName",
            "site_today_summary.BranchId",
            "site_today_summary.BranchName"
        ],
        "filters": [
            {
                "member": "site_today_summary.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
        ],
        "timeDimensions": [
            {
                "dimension": "site_today_summary.Time",
                "dateRange": [
                    "2024-01-01T00:00:00.000",
                    "2024-01-01T23:59:59.000"
                ],
                "granularity": "minute"
            }
        "order": [
            [
                "site_today_summary.BranchId",
                "asc"
            ],
            [
                "site_today_summary.Time",
                "asc"
            ],
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "site_today_summary.CompanyId": "12345",
            "site_today_summary.CompanyName": "DemoCompany",
            "site_today_summary.BranchId": "11111",
            "site_today_summary.BranchName": "DemoBranch",
            "site_today_summary.Time.minute": "2024-01-01T00:00:00.000",
            "site_today_summary.A03": 81
        },
        {
            "site_today_summary.CompanyId": "12345",
            "site_today_summary.CompanyName": "DemoCompany",
            "site_today_summary.BranchId": "11111",
            "site_today_summary.BranchName": "DemoBranch",
            "site_today_summary.Time.minute": "2024-01-01T00:01:00.000",
            "site_today_summary.A03": 52
        },
    ],
 
    ...
 
}

area_1d_summary

Description Store area daily level data
Cube Name area_1d_summary
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'day'.

day, week, month, year
Measures

Available metrics for this cube

  1. A01
  2. A02
  3. A03
  4. A04
  5. A05
  6. B01
  7. B03
  8. P01
  9. P23
  10. P25
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (number)
  3. AreaName (string)
  4. BranchId (number)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (number)
  8. CompanyName (string)
  9. OperateDate (datetime as string)
  10. IsWeekDay (number)
  11. IsPublicHoliday (number)
Body - JSON Example
{
    "query": {
        "measures": [
            "area_1d_summary.A01",
            "area_1d_summary.A02",
            "area_1d_summary.A03",
            "area_1d_summary.A04",
            "area_1d_summary.A05",
            "area_1d_summary.B01",
            "area_1d_summary.B03"
        ],
        "dimensions": [
            "area_1d_summary.CompanyId",
            "area_1d_summary.CompanyName",
            "area_1d_summary.BranchId",
            "area_1d_summary.BranchName",
            "area_1d_summary.AreaId",
            "area_1d_summary.AreaName"
        ],
        "filters": [
            {
                "member": "area_1d_summary.AreaId",
                "operator": "equals",
                "values": [
                    "33333"
                ]
            },
            {
                "member": "area_1d_summary.IsWeekday",
                "operator": "equals",
                "values": [
                    "true"
                ]
            },
        ],
        "timeDimensions": [
            {
                "dimension": "area_1d_summary.Time",
                "dateRange": [
                    "2024-01-01T00:00:00.000",
                    "2024-01-31T23:59:59.000"
                ],
                "granularity": "day"
            }
        ],
        "order": [
            [
                "area_1d_summary.Area",
                "asc"
            ],
            [
                "area_1d_summary.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "area_1d_summary.CompanyId": "12345",
            "area_1d_summary.CompanyName": "DemoCompany",
            "area_1d_summary.BranchId": "11111",
            "area_1d_summary.BranchName": "DemoBranch",
            "area_1d_summary.AreaId": "33333",
            "area_1d_summary.AreaName": "DemoArea",
            "area_1d_summary.Time.day": "2024-01-01T00:00:00.000",
            "area_1d_summary.A01": 4958,
            "area_1d_summary.A02": 6060,
            "area_1d_summary.A03": 241,
            "area_1d_summary.A04": 376.42,
            "area_1d_summary.A05": 5839,
            "area_1d_summary.B01": 0.4592,
            "area_1d_summary.B03": 0.3213
        },
        {
            "area_1d_summary.CompanyId": "12345",
            "area_1d_summary.CompanyName": "DemoCompany",
            "area_1d_summary.BranchId": "11111",
            "area_1d_summary.BranchName": "DemoBranch",
            "area_1d_summary.AreaId": "33333",
            "area_1d_summary.AreaName": "DemoArea",
            "area_1d_summary.Time.day": "2024-01-02T00:00:00.000",
            "area_1d_summary.A01": 2345,
            "area_1d_summary.A02": 1234,
            "area_1d_summary.A03": 132,
            "area_1d_summary.A04": 256.23,
            "area_1d_summary.A05": 4531,
            "area_1d_summary.B01": 0.3410,
            "area_1d_summary.B03": 0.1253
        },
    ],
 
    ...
 
}

area_1h_summary

Description Store area hourly level data
Cube Name area_1h_summary
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'hour'.

hour, day, week, month, year
Measures

Available metrics for this cube

  1. A01
  2. A02
  3. A03
  4. A04
  5. A05
  6. B01
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (number)
  3. AreaName (string)
  4. BranchId (number)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (number)
  8. CompanyName (string)
  9. OperateDate (datetime as string)
  10. IsWeekDay (number)
  11. IsPublicHoliday (number)
Body - JSON Example
{
    "query": {
        "measures": [
            "area_1h_summary.A01",
            "area_1h_summary.A02",
            "area_1h_summary.A03",
            "area_1h_summary.A04",
            "area_1h_summary.A05",
            "area_1h_summary.B01"
        ],
        "dimensions": [
            "area_1h_summary.CompanyId",
            "area_1h_summary.CompanyName",
            "area_1h_summary.BranchId",
            "area_1h_summary.BranchName",
            "area_1h_summary.AreaId",
            "area_1h_summary.AreaName"
        ],
        "filters": [
            {
                "member": "area_1h_summary.AreaId",
                "operator": "equals",
                "values": [
                    "33333"
                ]
            },
            {
                "member": "area_1h_summary.IsWeekday",
                "operator": "equals",
                "values": [
                    "true"
                ]
            }
        ],
        "timeDimensions": [
            {
                "dimension": "area_1h_summary.Time",
                "dateRange": [
                    "2024-01-01T00:00:00.000",
                    "2024-01-31T23:59:59.000"
                ],
                "granularity": "hour"
            }
        ],
        "order": [
            [
                "area_1h_summary.AreaId",
                "asc"
            ],
            [
                "area_1h_summary.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "area_1h_summary.CompanyId": "12345",
            "area_1h_summary.CompanyName": "DemoCompany",
            "area_1h_summary.BranchId": "11111",
            "area_1h_summary.BranchName": "DemoBranch",
            "area_1h_summary.AreaId": "33333",
            "area_1h_summary.AreaName": "DemoArea",
            "area_1h_summary.Time.hour": "2024-01-01T00:00:00.000",
            "area_1h_summary.A01": 4958,
            "area_1h_summary.A02": 6060,
            "area_1h_summary.A03": 241,
            "area_1h_summary.A04": 376.42,
            "area_1h_summary.A05": 5839,
            "area_1h_summary.B01": 0.4592
        },
        {
            "area_1h_summary.CompanyId": "12345",
            "area_1h_summary.CompanyName": "DemoCompany",
            "area_1h_summary.BranchId": "11111",
            "area_1h_summary.BranchName": "DemoBranch",
            "area_1h_summary.AreaId": "33333",
            "area_1h_summary.AreaName": "DemoArea",
            "area_1h_summary.Time.hour": "2024-01-01T01:00:00.000",
            "area_1h_summary.A01": 2345,
            "area_1h_summary.A02": 1234,
            "area_1h_summary.A03": 132,
            "area_1h_summary.A04": 256.23,
            "area_1h_summary.A05": 4531,
            "area_1h_summary.B01": 0.3410
        },
    ],
 
    ...
 
}

area_1m_summary

Description Store area minute level data
Cube Name area_1m_summary
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'minute'.

minute, hour, day, week, month, year
Measures

Available metrics for this cube

  1. A01
  2. A02
  3. A03
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (number)
  3. AreaName (string)
  4. BranchId (number)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (number)
  8. CompanyName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "area_1m_summary.A01",
            "area_1m_summary.A02",
            "area_1m_summary.A03"
        ],
        "dimensions": [
            "area_1m_summary.CompanyId",
            "area_1m_summary.CompanyName",
            "area_1m_summary.BranchId",
            "area_1m_summary.BranchName",
            "area_1m_summary.AreaId",
            "area_1m_summary.AreaName"
        ],
        "filters": [
            {
                "member": "site_1m_summary.AreaId",
                "operator": "equals",
                "values": [
                    "33333"
                ]
            },
        ],
        "timeDimensions": [
            {
                "dimension": "area_1m_summary.Time",
                "dateRange": [
                    "2024-01-01T00:00:00.000",
                    "2024-01-01T23:59:59.000"
                ],
                "granularity": "minute"
            }
        ],
        "order": [
            [
                "area_1m_summary.AreaId",
                "asc"
            ],
            [
                "area_1m_summary.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "area_1m_summary.CompanyId": "12345",
            "area_1m_summary.CompanyName": "DemoCompany",
            "area_1m_summary.BranchId": "11111",
            "area_1m_summary.BranchName": "DemoBranch",
            "area_1m_summary.AreaId": "33333",
            "area_1m_summary.AreaName": "DemoArea",
            "area_1m_summary.Time.minute": "2024-01-01T00:00:00.000",
            "area_1m_summary.A01": 3,
            "area_1m_summary.A02": 5,
            "area_1m_summary.A03": 81
        },
        {
            "area_1m_summary.CompanyId": "12345",
            "area_1m_summary.CompanyName": "DemoCompany",
            "area_1m_summary.BranchId": "11111",
            "site_1m_summary.BranchName": "DemoBranch",
            "area_1m_summary.AreaId": "33333",
            "area_1m_summary.AreaName": "DemoArea",
            "area_1m_summary.Time.minute": "2024-01-01T00:01:00.000",
            "area_1m_summary.A01": 5,
            "area_1m_summary.A02": 2,
            "area_1m_summary.A03": 52
        },
    ],
 
    ...
 
}

area_live_summary

Description Store live area level data
Cube Name area_live_summary
Measures

Available metrics for this cube

  1. A03
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. AreaId (number)
  2. AreaName (string)
  3. BranchId (number)
  4. BranchCode (string)
  5. BranchName (string)
  6. CompanyId (number)
  7. CompanyName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "area_live_summary.A03"
        ],
        "dimensions": [
            "area_live_summary.CompanyId",
            "area_live_summary.CompanyName",
            "area_live_summary.BranchId",
            "area_live_summary.BranchName",
            "area_live_summary.AreaId",
            "area_live_summary.AreaName"
        ],
        "filters": [
            {
                "member": "area_live_summary.AreaId",
                "operator": "equals",
                "values": [
                    "33333",
                    "44444"
                ]
            },
        ],
        "order": [
            [
                "area_live_summary.AreaId",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "area_live_summary.CompanyId": "12345",
            "area_live_summary.CompanyName": "DemoCompany",
            "area_live_summary.BranchId": "11111",
            "area_live_summary.BranchName": "DemoBranch",
            "area_live_summary.AreaId": "33333",
            "area_live_summary.AreaName": "DemoArea",
            "area_live_summary.A03": 81
        },
        {
            "area_live_summary.CompanyId": "12345",
            "area_live_summary.CompanyName": "DemoCompany",
            "area_live_summary.BranchId": "11111",
            "area_live_summary.BranchName": "DemoBranch",
            "area_live_summary.AreaId": "44444",
            "area_live_summary.AreaName": "DemoArea2",
            "area_live_summary.A03": 52
        },
    ],
 
    ...
 
}

area_1x_prediction

Description Store area level prediction data
Cube Name area_1m_prediction, area_1h_prediction, area_1d_prediction, area_1m_prediction
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'minute'.

minute, hour, day, month
Measures

Available metrics for this cube

  1. P01
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. AreaId (number)
  3. AreaName (string)
  4. BranchId (number)
  5. BranchCode (string)
  6. BranchName (string)
  7. CompanyId (number)
  8. CompanyName (string)
  9. AreaGroupId (number)
  10. AreaGroupName (string)
  11. AreaType (string)
  12. SiteGroupId (number)
  13. SiteGroupName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "area_1h_prediction.P01"
        ],
        "dimensions": [
            "area_1h_prediction.CompanyId",
            "area_1h_prediction.CompanyName",
            "area_1h_prediction.BranchId",
            "area_1h_prediction.BranchName"
        ],
        "filters": [
            {
                "member": "area_1h_prediction.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            }
        ],
        "timeDimensions": [
            {
                "dimension": "area_1h_prediction.Time",
                "dateRange": [
                    "2024-01-01T00:00:00.000",
                    "2024-01-01T23:59:59.000"
                ],
                "granularity": "hour"
            }
         ],
        "order": [
            [
                "area_1h_prediction.BranchId",
                "asc"
            ],
            [
                "area_1h_prediction.Time",
                "asc"
            ]
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "site_today_summary.CompanyId": "12345",
            "site_today_summary.CompanyName": "DemoCompany",
            "site_today_summary.BranchId": "11111",
            "site_today_summary.BranchName": "DemoBranch",
            "site_today_summary.Time.minute": "2024-01-01T00:00:00.000",
            "site_today_summary.P03": 104
        },
        {
            "site_today_summary.CompanyId": "12345",
            "site_today_summary.CompanyName": "DemoCompany",
            "site_today_summary.BranchId": "11111",
            "site_today_summary.BranchName": "DemoBranch",
            "site_today_summary.Time.minute": "2024-01-01T00:01:00.000",
            "site_today_summary.A03": 152
        },
    ],
 
    ...
 
}

area_today_summary

Description Store today's area level data
Cube Name area_today_summary
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'minute'.

minute, hour, day
Measures

Available metrics for this cube

  1. A03
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. Time1Hour (datetime as string). Use this instead of Time to filter for 1 hour of granularity
  3. AreaId (number)
  4. AreaName (string)
  5. BranchId (number)
  6. BranchCode (string)
  7. BranchName (string)
  8. CompanyId (number)
  9. CompanyName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "area_today_summary.A03"
        ],
        "dimensions": [
            "area_today_summary.CompanyId",
            "area_today_summary.CompanyName",
            "area_today_summary.BranchId",
            "area_today_summary.BranchName"
        ],
        "filters": [
            {
                "member": "area_today_summary.BranchId",
                "operator": "equals",
                "values": [
                    "11111",
                    "22222"
                ]
            },
        ],
        "timeDimensions": [
            {
                "dimension": "area_today_summary.Time",
                "dateRange": [
                    "2024-01-01T00:00:00.000",
                    "2024-01-01T23:59:59.000"
                ],
                "granularity": "minute"
            }
        ],
        "order": [
            [
                "area_today_summary.BranchId",
                "asc"
            ],
            [
                "area_today_summary.Time",
                "asc"
            ],
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "area_today_summary.CompanyId": "12345",
            "area_today_summary.CompanyName": "DemoCompany",
            "area_today_summary.BranchId": "11111",
            "area_today_summary.BranchName": "DemoBranch",
            "area_today_summary.Time.minute": "2024-01-01T00:00:00.000",
            "area_today_summary.A03": 81
        },
        {
            "area_today_summary.CompanyId": "12345",
            "area_today_summary.CompanyName": "DemoCompany",
            "area_today_summary.BranchId": "11111",
            "area_today_summary.BranchName": "DemoBranch",
            "area_today_summary.Time.minute": "2024-01-01T00:01:00.000",
            "area_today_summary.A03": 52
        },
    ],
 
    ...
 
}

device_1d_summary

Description Store device daily level data
Cube Name device_1d_summary
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'day'.

day, week, month, year
Measures

Available metrics for this cube

  1. A01
  2. A02
  3. A03
  4. A04
  5. A05
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. Serial (string)
  3. BranchId (number)
  4. BranchCode (string)
  5. BranchName (string)
  6. CompanyId (number)
  7. CompanyName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "device_1d_summary.A01",
            "device_1d_summary.A02",
            "device_1d_summary.A03",
            "device_1d_summary.A04",
            "device_1d_summary.A05"
        ],
        "dimensions": [
            "device_1d_summary.CompanyId",
            "device_1d_summary.CompanyName",
            "device_1d_summary.BranchId",
            "device_1d_summary.BranchName",
            "device_1d_summary.Serial"
        ],
        "filters": [
            {
                "member": "device_1d_summary.Serial",
                "operator": "equals",
                "values": [
                    "000000123def789",
                    "000000abc456ghi"
                ]
            },
        ],
        "timeDimensions": [
            {
                "dimension": "device_1d_summary.Time",
                "dateRange": [
                    "2024-01-01T00:00:00.000",
                    "2024-01-31T23:59:59.000"
                ],
                "granularity": "day"
            }
        ],
        "order": [
            [
                "device_1d_summary.Serial",
                "asc"
            ],
            [
                "device_1d_summary.Time",
                "asc"
            ],
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "device_1d_summary.CompanyId": "12345",
            "device_1d_summary.CompanyName": "DemoCompany",
            "device_1d_summary.BranchId": "11111",
            "device_1d_summary.BranchName": "DemoBranch",
            "device_1d_summary.Serial": "000123def789",
            "device_1d_summary.Time.day": "2024-01-01T00:00:00.000",
            "device_1d_summary.A01": 4958,
            "device_1d_summary.A02": 6060,
            "device_1d_summary.A03": 241,
            "device_1d_summary.A04": 376.42,
            "device_1d_summary.A05": 5839
        },
        {
            "device_1d_summary.CompanyId": "12345",
            "device_1d_summary.CompanyName": "DemoCompany",
            "device_1d_summary.BranchId": "11111",
            "device_1d_summary.BranchName": "DemoBranch",
            "device_1d_summary.Serial": "000123def789",
            "device_1d_summary.Time.day": "2024-01-02T00:00:00.000",
            "device_1d_summary.A01": 3728,
            "device_1d_summary.A02": 5102,
            "device_1d_summary.A03": 184,
            "device_1d_summary.A04": 150.42,
            "device_1d_summary.A05": 4320
        },
    ],
 
    ...
 
}

device_1h_summary

Description Store device hourly level data
Cube Name device_1h_summary
Time granularities

Following are available time granularities for this cube, minimum time granularity is 'hour'.

hour, day, week, month, year
Measures

Available metrics for this cube

  1. A01
  2. A02
  3. A03
  4. A04
  5. A05
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Time (datetime as string) : Example "2021-10-01T10:00:00.000", "2021-10-01T10:00"
  2. Serial (string)
  3. BranchId (number)
  4. BranchCode (string)
  5. BranchName (string)
  6. CompanyId (number)
  7. CompanyName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "device_1h_summary.A01",
            "device_1h_summary.A02",
            "device_1h_summary.A03",
            "device_1h_summary.A04",
            "device_1h_summary.A05"
        ],
        "dimensions": [
            "device_1h_summary.CompanyId",
            "device_1h_summary.CompanyName",
            "device_1h_summary.BranchId",
            "device_1h_summary.BranchName",
            "device_1h_summary.Serial"
        ],
        "filters": [
            {
                "member": "device_1h_summary.Serial",
                "operator": "equals",
                "values": [
                    "000000123def789",
                    "000000abc456ghi"
                ]
            },
        ],
        "timeDimensions": [
            {
                "dimension": "device_1h_summary.Time",
                "dateRange": [
                    "2024-01-01T00:00:00.000",
                    "2024-01-31T23:59:59.000"
                ],
                "granularity": "hour"
            }
        ],
        "order": [
            [
                "device_1h_summary.Serial",
                "asc"
            ],
            [
                "device_1h_summary.Time",
                "asc"
            ],
        ],
        "limit": 10
    }
}
Response - JSON Example
{
 
    ...
 
    "data": [
        {
            "device_1h_summary.CompanyId": "12345",
            "device_1h_summary.CompanyName": "DemoCompany",
            "device_1h_summary.BranchId": "11111",
            "device_1h_summary.BranchName": "DemoBranch",
            "device_1h_summary.Serial": "000123def789",
            "device_1h_summary.Time.hour": "2024-01-01T00:00:00.000",
            "device_1h_summary.A01": 4958,
            "device_1h_summary.A02": 6060,
            "device_1h_summary.A03": 241,
            "device_1h_summary.A04": 376.42,
            "device_1h_summary.A05": 5839
        },
        {
            "device_1h_summary.CompanyId": "12345",
            "device_1h_summary.CompanyName": "DemoCompany",
            "device_1h_summary.BranchId": "11111",
            "device_1h_summary.BranchName": "DemoBranch",
            "device_1h_summary.Serial": "000123def789",
            "device_1h_summary.Time.hour": "2024-01-01T01:00:00.000",
            "device_1h_summary.A01": 3728,
            "device_1h_summary.A02": 5102,
            "device_1h_summary.A03": 184,
            "device_1h_summary.A04": 150.42,
            "device_1h_summary.A05": 4320
        },
    ],
 
    ...
 
}

device_live_summary

Description Store device level live data
Cube Name device_live_summary
Measures

Available metrics for this cube

  1. A03
Dimensions

Following fields can be used for applying filtering and ordering the data.

  1. Serial (string)
  2. BranchId (number)
  3. BranchCode (string)
  4. BranchName (string)
  5. CompanyId (number)
  6. CompanyName (string)
Body - JSON Example
{
    "query": {
        "measures": [
            "device_live_summary.A03"
        ],
        "dimensions": [
            "device_live_summary.CompanyId",
            "device_live_summary.CompanyName",
            "device_live_summary.BranchId",
            "device_live_summary.BranchName",
            "device_live_summary.Serial"
        ],
        "filters": [
            {
                "member": "device_live_summary.Serial",
                "operator": "equals",
                "values": [
                    "000000123def789",
                    "000000abc456ghi"
                ]
            },
        ],
        "order": [
            [
                "device_live_summary.Serial",
                "asc"
            ]
        ],
        "limit": 10
    }
}

The post List of Cube (Deprecated) appeared first on FootfallCam.

]]>