获取企业接收红包统计数据新版SDK
更新于 2024-01-11调用本接口获取企业接收红包（抢红包）的统计数据。
为了更好支持组织对钉钉数据分析和管理的需求，钉钉数据资产平台将统一所有数据资产相关的产品和服务，从数据层、功能层、业务层做升级，提供更好的服务体验。为此，我们将数据资产类 OpenAPI 接口的使用路径和产品定位做了调整，本开发者文档中所述 OpenAPI 接口及 60 个其他的数据资产类OpenAPI接口，已于 2023 年 9 月 1 日关闭开发者后台应用开发的权限申请入口，客户可以通过钉钉数据资产平台获取相应的数据服务。
本文档已于 2023 年 9 月 1 日迁移至历史文档（不推荐）目录，且本接口仅保持现有功能，不再新增支持其他能力，说明如下：
统计日期 | 组织ID | 接收红包数 | 接收拼手气红包数 | 接收专享红包数 | 接收红包用户数 | 接收拼手气红包用户数 | 接收专享红包用户数 |
20210101 | 12345 | 89 | 81 | 8 | 64 | 57 | 8 |
权限
要调用此API，需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
企业内部应用 | 支持 | 数据服务目录红包统计读权限 | 重要 暂不支持新增申请。 |
第三方企业应用 | 暂不支持 | 数据服务目录红包统计读权限 | 暂不支持 |
第三方个人应用 | 暂不支持 | 数据服务目录红包统计读权限 | 暂不支持 |
请求方法
Header参数
名称 | 类型 | 是否必填 | 描述 |
x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证：
|
Query参数
名称 | 类型 | 是否必填 | 描述 |
statDate | String | 是 | 查询时间，日期格式为yyyyMMdd。 |
返回参数
名称 | 类型 | 描述 |
dataList | Array of Object | 指标数据列表。 说明 指标数据为Map类型，指标值的取值key为指标ID_指标周期，例如：4001_DAY。 |
metaList | Array | 指标元数据列表，包括指标ID、指标名称、指标周期、指标口径等信息。 |
kpiId | String | 字段ID。 |
kpiName | String | 字段名称。 |
unit | String | 字段单位。 |
kpiCaliber | String | 字段描述。 |
period | String | 字段统计周期。 |
示例
请求示例
返回示例
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
400 | IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. | client token不合法。 |
500 | statDate.is.null | statDate请求参数为空 | statDate请求参数为空 |
500 | service.meta.isNull | service meta信息为空 | service meta信息为空 |
500 | serviceId.is.null | serviceId为空 | serviceId为空 |
500 | systemError | 系统异常 | 系统异常，请稍后重试 |
500 | orgId.is.null | orgId请求参数为空 | orgId请求参数为空 |
500 | statDate.format.iserror | statDate请求参数格式不正确，正确格式：yyyyMMdd | statDate请求参数格式不正确，正确格式：yyyyMMdd |
500 | unknownError | 未知错误 | 未知错误 |
