JavaSDK 数据查询API调用说明

  • 如果您对API使用安全性有更高要求,可以在本SDK的基础上额外增加数据加密或签名验证等处理流程。

在使用本功能前,请首先参考 调用方管理 创建调用方,调用方管理提供验证API接口的授权信息、调用量监控等相关功能!

  • 在已创建调用方和申请相应元素授权的情况下,再进行以下操作!
  • 范例代码请参考单元测试:com.dtstep.lighthouse.core.test.api.RpcDataQueryTest

SDK引用

<!-- 使用MvnRepository中的最新版本即可,请使用2.2.8或以上版本 -->
<dependency>
    <groupId>com.dtstep.lighthouse</groupId>
    <artifactId>lighthouse-shaded-client</artifactId>
    <version>2.2.8</version>
</dependency>

LightHouse.dataDurationQuery(String callerName, String callerKey, int statId, String dimensValue, long startTime, long endTime)

参数: callerName: 调用方名称; callerKey: 调用方秘钥, statId: 统计项标识; dimensValue: 维度信息; startTime: 查询开始时间; endTime: 查询结束时间;

作用:通过指定维度和时间范围查询统计结果数据。

LightHouse.dataQuery(String callerName, String callerKey, int statId, String dimensValue, List batchList)

参数:callerName: 调用方名称; callerKey: 调用方秘钥, statId,统计项标识;dimensValue,维度信息;batchList,批次时间;

作用:通过指定维度和批次时间查询统计结果数据。

LightHouse.dataDurationQueryWithDimensList(String callerName, String callerKey, int statId, List dimensValueList, long startTime,long endTime)

参数:callerName: 调用方名称; callerKey: 调用方秘钥, statId,统计项标识;dimensValueList,维度信息列表;batchList,批次时间;

作用:批量查询多条维度参数的统计结果数据。

LightHouse.dataQueryWithDimensList(String callerName, String callerKey, int statId, List dimensValueList, List batchList)

参数:callerName: 调用方名称; callerKey: 调用方秘钥, statId,统计项标识;dimensValue,维度信息列表(没有维度参数传null,多维度统计按照统计项维度配置使用分号分割);batchList,批次时间;

作用:按照批次时间,批量查询多条维度参数的统计结果数据。

LightHouse.limitQuery(String callerName, String callerKey, int statId, Long batchTime)

参数:callerName: 调用方名称; callerKey: 调用方秘钥,statId,统计项标识;batchTime,批次时间;

作用:按照批次时间,查询Limit的统计结果。

传入参数说明

startTime/endTime参数

查询数据的起止时间,请使用13位时间戳。

batchList参数

系统按照统计项TimeParam参数划分统计周期,使用统计周期的开始时间作为统计周期的批次时间,在传递batchTime/batchList相关参数时,请使用13位时间戳。

比如:

  • 统计业务每分钟访问PV,则2024-05-02 13:15:00代表2024-05-02 13:15:00 至 2024-05-02 13:16:00的统计数据对应的批次时间。

  • 统计业务每2小时访问UV,则2024-05-02 14:00:00代表2024-05-02 14:00:00 至 2024-05-02 16:00:00的统计数据对应的批次时间。

  • 统计业务每天的订单量,则2024-05-02 00:00:00代表2024-05-02 00:00:00 至 2024-05-02 23:59:59的统计数据对应的批次时间。

dimensValue参数

没有维度参数传null,多维度统计按照统计项维度配置使用分号分割。

比如:

  • 查询业务每天订单金额,
<stat-item title="每天_订单金额" stat="sum(amount)" />

该示例没有统计维度则传null。

  • 查询每个各省份订单金额。
<stat-item title="每天_各省份_订单金额" stat="sum(amount)" dimens="provinceId"/>

该示例维度参数为省份,请传省份参数信息,格式示例:10101 或 10102。

  • 查询每个省份各个业务线的订单金额,该示例为维度查询,请按照
<stat-item title="每天_各省份_各业务线_订单金额" stat="sum(amount)" dimens="provinceId;bizId"/>

该示例维度参数为省份和业务线,请按照provinceId;bizId的格式拼接维度参数,格式示例:10101;1 或 10102;2。

results matching ""

    No results matching ""