获取企业单聊统计数据

说明

调用本接口获取企业即时沟通中单聊的统计数据。
服务地址：api.dingtalk.com

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	数据服务目录即时沟通统计读权限	API Explorer
第三方企业应用	暂不支持	数据服务目录即时沟通统计读权限	暂不支持
第三方个人应用	暂不支持	数据服务目录即时沟通统计读权限	暂不支持

错误码

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	未知错误	未知错误

请求参数

Query 参数

statDate

string

必需

查询时间，日期格式为yyyyMMdd。

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。

Body 参数application/json

object {0}

示例

{}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

dataList

array [object]

可选

指标数据列表。
指标数据为Map类型，指标值的取值key为指标ID_指标周期，例如：4001_DAY。

metaList

array [object {5}]

可选

指标元数据列表，包括指标ID、指标名称、指标周期、指标口径等信息。

kpiId

string

字段ID。

可选

kpiName

string

字段名称。

可选

unit

string

字段单位。

可选

kpiCaliber

string

字段描述。

可选

period

string

字段统计周期。

可选

示例

{
  "dataList": [
    {}
  ],
  "metaList": [
    {
      "kpiId": "string",
      "kpiName": "string",
      "unit": "string",
      "kpiCaliber": "string",
      "period": "string"
    }
  ]
}

获取企业单聊统计数据

说明#

权限#

错误码#

请求参数

示例代码

返回响应

说明

权限

错误码