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",
                “ desc”
            ]
        ],
        “过滤器”：[
            {
                "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更新