报告

获取报告文件列表

接口说明

获取报告文件列表

请求信息

配置说明	参数值
URL	/report/file?partition_by=day&partition_start=20250218&partition_end=20250218&type=store-daily-report
Method	GET

请求参数

参数名	类型	描述	是否必填
partition_by	string	报告周期分区类型 day:天 week:周 month:月 quarter:季 year:年	是
partition_start	int64	报告周期分区开始，格式说明见报告周期分区说明	是
partition_end	int64	报告周期分区结束，格式说明见报告周期分区说明	是
type	string	报告类型	否

注意： 接口最多支持返回2000条数据，超出2000条请缩短报告周期分区区间范围。

报告周期分区说明

报告周期分区根据报告周期分区类型partition_by定义格式不同，具体支持的格式如下表：

报告周期分区类型	报告周期分区格式	示例	备注
天	yyyyMMdd	20250218
周	yyyyww	202550	01 - 52周
月	yyyyMM	202502	01 - 12月
季度	yyyyq	20251	1 - 4季度
年	yyyy	2025

响应数据

data数据格式

参数名	类型	描述
results	[]object	结果对象列表
+ id	int64	报告id
+ type	string	报告类型
+ partition_by	string	报告周期分区类型
+ partition	int64	报告周期分区，可能是某天或某月
+ url	string	报告文件链接
+ md5	string	报告文件md5值
+ update_time	int64	报告最后更新时间（毫秒时间戳）

注意： 当报告数据有更新时，会返回最新的报告文件链接，请注意对比报告文件md5值或者update_time是否有变化，如有变化请重新下载。

响应数据样例

{
  "code": 0,
  "message": "",
  "data": {
    "results": [
      {
        "id": 1,
        "type": "store-daily-report",
        "partition_by": "day",
        "partition": 20250218,
        "url": "https://f-dev.clobotics.cn/4/0040ca4d85f5e5ef7354102f486ef877.csv",
        "md5": "15e2bbd5a19437ffe3b29e5661ed36aa",
        "update_time": 1668478888000
      }
    ]
  }
}

获取报告配置

接口说明

获取报告配置

请求信息

配置说明	参数值
URL	/report/config
Method	GET

响应数据

data数据格式

参数名	类型	描述
results	[]object	结果对象列表
+ type	string	报告类型
+ name	string	报告名称
+ partition_by	string	报告周期分区类型 day:天 week:周 month:月 quarter:季 year:年
+ output	string	输出方式： file: 返回报告文件下载地址;

响应数据样例

{
  "code": 0,
  "message": "",
  "data": {
    "results": [
      {
        "type": "store-daily-report",
        "name": "门店日报",
        "partition_by": "day",
        "output": "file"
      }
    ]
  }
}