1. 首頁
  2. 使用說明書
  3. RESTful API 文檔
  4. 計數數據 API [測試版]
搜索...

計數數據 API [測試版]

產品描述 通過在 JSON 字符串中提供計數數據的類型和查詢有效負載對象來調用此端點，以獲取 JSON 格式的計數數據。
端點

{CubeHostAddress}/API/v1/load

{CubeHostAddress}：https://cube.footfallcam.com（如果您使用的是本地解決方案，請在主機地址上諮詢 FootfallCam 支持）
選項 解決方案&帖子
頭
  1. Authorization : Token 值返回自 API“生成訪問令牌” 通過提供用戶名和密碼
正文 - JSON 示例 {
    “詢問”： {
        “措施”：[
            "ThisCubeName.FC01_SUM",
            "ThisCubeName.FC01_AVG",
            "ThisCubeName.FC02_SUM",
            "ThisCubeName.FC02_AVG"
        ],
        “時間維度”：[
            {
                "維度": "ThisCubeName.Time",
                “日期範圍”： [
                    "2021-10-01T10:00:00.000",
                    “ 2021-10-31”
                ],
                “粒度”：“小時”
            }
        ],
        “命令”： [
            [
                "ThisCubeName.FC01_SUM",
                “描述”
            ]
        ],
        “過濾器”：[
            {
                "member": "ThisCubeName.CompanyId",
                “運算符”：“等於”，
                “價值觀”：[
                    “1001”
                ]
            },
            {
                "member": "ThisCubeName.BranchId",
                “運算符”：“等於”，
                “價值觀”：[
                    “2001”，
                    “2001”
                ]
            },
            {
                "member": "ThisCubeName.BranchName",
                “運算符”：“等於”，
                “價值觀”：[
                    "分支名稱1",
                    “分支名稱2”
                ]
            },
            {
                "member": "ThisCubeName.AreaId",
                “運算符”：“等於”，
                “價值觀”：[
                    “3001”，
                    “3002”，
                    “3003”
                ]
            }
        ],
        “方面”： [
            "ThisCubeName.CompanyId",
            "ThisCubeName.CompanyName",
            "ThisCubeName.BranchId",
            "ThisCubeName.BranchName",
            "ThisCubeName.AreaId",
            "ThisCubeName.AreaName"
        ],
        “限制”：50000
    }
}
身體描述

有效載荷中必須提及多維數據集名稱，其可用字段取決於所選的多維數據集。 請參考 立方體列表 立方體細節

  1. query (object) : 為查詢數據定義有效負載
  2. 措施（字符串列表）：定義度量代碼列表和聚合類型。
  3. timeDimensions (list of object) : 包含一個定義時間相關參數的對象
    1. 維度（字符串）：指定應用時間相關參數的維度
    2. dateRange（字符串列表）：指定數據查詢的開始和結束日期時間。 示例：“2021-10-01T10:00:00.000”、“2021-10-31”
    3. 粒度（字符串）：定義數據的時間粒度。 示例：分、時、日、週、月、年
  4. order (list of string)：指定數據的順序。 每個次要列表都包含要應用排序的字段名稱和相應的排序類型。 示例：["ThisCubeName.FC01_SUM", "desc"]
  5. 過濾器（對象列表）：定義查詢數據的過濾。
    1. 成員（字符串）：指定應用過濾器的維度。
    2. 運算符（字符串）：定義過濾器的類型。 示例：equals、notEquals、contains、notContains
    3. values（字符串列表）：指定過濾數據的值。
  6. 維度（字符串列表）：指定要在結果數據中顯示的維度，類似於 SQL 查詢中的“選擇”語句。
  7. limit (int, optional) : 指定返回數據的最大記錄數。 默認值為 10000（如果未在有效負載中指定），最大值為 50000。
響應 1 - JSON 示例 {
    "error": "繼續等待",
    “階段”： {
        "stage": "執行查詢",
        “經過的時間”：5003
    }
}
回應 1 描述 “繼續等待”響應只是表明後端可能需要一些時間來執行查詢並返回結果。 這不是由於 API 調用失敗，查詢正在後端執行。 之後重試，一旦後端完成查詢，API 將返回結果。
響應 2 - JSON 示例 {
    “詢問”： {}，
    “數據”： [
{
            "cube3.CompanyId": "18330",
            "cube3.CompanyName": "DemoCompany",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.AreaId": "-1",
            “cube3.AreaName”： 空,
            "cube3.Time.hour": "2022-01-15T11:00:00.000",
            "cube3.Time": "2022-01-15T11:00:00.000",
            “立方體3.FC01_SUM”：200，
            “立方體3.FC01_MAX”：180，
            “立方體3.FC01_AVG”：100，
            “cube3.FC01_MIN”：20，
            “立方體3.FC02_SUM”：188，
            “立方體3.FC02_MAX”：171，
            “立方體3.FC02_AVG”：94，
            “立方體3.FC02_MIN”：17
        },
        {
            "cube3.CompanyId": "18330",
            "cube3.CompanyName": "DemoCompany",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.AreaId": "-1",
            “cube3.AreaName”： 空,
            "cube3.Time.hour": "2022-01-07T15:00:00.000",
            "cube3.Time": "2022-01-07T15:00:00.000",
            “立方體3.FC01_SUM”：175，
            “立方體3.FC01_MAX”：100，
            “立方體3.FC01_AVG”：87.5，
            “cube3.FC01_MIN”：75，
            “立方體3.FC02_SUM”：174，
            “立方體3.FC02_MAX”：95，
            “立方體3.FC02_AVG”：87，
            “立方體3.FC02_MIN”：79
        },
        {
            "cube3.CompanyId": "18330",
            "cube3.CompanyName": "DemoCompany",
            "cube3.BranchId": "23097",
            "cube3.BranchName": "UKSite01",
            "cube3.AreaId": "-1",
            “cube3.AreaName”： 空,
            "cube3.Time.hour": "2022-01-15T13:00:00.000",
            "cube3.Time": "2022-01-15T13:00:00.000",
            “立方體3.FC01_SUM”：171，
            “立方體3.FC01_MAX”：151，
            “立方體3.FC01_AVG”：85.5，
            “cube3.FC01_MIN”：20，
            “立方體3.FC02_SUM”：166，
            “立方體3.FC02_MAX”：146，
            “立方體3.FC02_AVG”：83，
            “立方體3.FC02_MIN”：20
        }
],
    "lastRefreshTime": "2022-01-19T07:35:41.259Z",
    “刷新鍵值”：[
        [
            {
                “刷新鍵”：“13688147”
            }
        ]
    ],
    “usedPreAggregations”：{}，
    “transformedQuery”：{}，
    "requestId": "dda53bef-4d52-4377-aee8-74d2976cafc6-span-1",
    “註釋”：{}，
    “數據源”：“默認”，
    "dbType": "prestodb",
    "extDbType": "多維數據集",
    “外部”：錯誤，
    “慢查詢”：假
}
回應 2 描述 計數數據結果將作為對象列表在“數據”部分中，將來可能會刪除其他附加信息。
2月22，2023更新