拉取运营数据

最近更新时间:2019-08-02 18:40:08

功能说明

App 管理员可以通过该接口拉取最近30天的运营数据,可拉取的字段见下文可拉取的运营字段。

接口调用说明

请求 URL 示例

https://console.tim.qq.com/v4/openconfigsvr/getappinfo?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介

参数 说明
v4/openconfigsvr/getappinfo 请求接口
sdkappid 创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier 必须为 App 管理员帐号,更多详情请参见 App 管理员
usersig App 管理员帐号生成的签名,具体操作请参见 生成 UserSig
random 请输入随机的32位无符号整数

最高调用频率

100次/秒。如需提升调用频率,请根据 工单模板 提交工单申请处理。

请求包示例

查询 SDKAppID 的最近30天的运营数据。

  • 基础形式
    默认拉取所有字段
    {}
  • 指定拉取字段
    用 RequestField 指定需要拉取的字段。
    {
      "RequestField":[
          "ChainIncrease",
          "ChainDecrease"
      ]
    }

请求包字段说明

字段 类型 属性 说明
RequestField Array 选填 该字段用来指定需要拉取的运营数据,不填默认拉取所有字段。详细可参阅下文可拉取的运营字段

应答包体示例

  • 基础形式
    {
      "ErrorCode": 0,
      "ErrorInfo": "OK",
      "Result": [{
          "APNSMsgNum": "84",
          "ActiveUserNum": "2014",
          "AppId": "1104620500",
          "AppName": "实时通信场景体验版",
          "C2CAPNSMsgNum": "84",
          "C2CDownMsgNum": "11040",
          "C2CSendMsgUserNum": "9",
          "C2CUpMsgNum": "52209",
          "CallBackReq": "73069",
          "CallBackRsp": "72902",
          "ChainDecrease": "16",
          "ChainIncrease": "18",
          "Company": "林野",
          "Date": "20160607",
          "DownMsgNum": "11869",
          "GroupAPNSMsgNum": "0",
          "GroupAllGroupNum": "41913",
          "GroupDestroyGroupNum": "35019",
          "GroupDownMsgNum": "829",
          "GroupJoinGroupTimes": "121438",
          "GroupNewGroupNum": "35904",
          "GroupQuitGroupTimes": "108292",
          "GroupSendMsgGroupNum": "5189",
          "GroupSendMsgUserNum": "12",
          "GroupUpMsgNum": "8433",
          "LoginTimes": "13708",
          "LoginUserNum": "2094",
          "MaxOnlineNum": "62",
          "RegistUserNumOneDay": "1052",
          "RegistUserNumTotal": "53091",
          "SendMsgUserNum": "19",
          "UpMsgNum": "60642",
      }]
    }
  • 指定拉取字段
    {
      "ErrorCode":0,
      "ErrorInfo":"OK",
      "Result":[{
              "ChainDecrease":"8",
              "ChainIncrease":"8",
              "Date":"20160605"
          },
          {
              "ChainDecrease":"17",
              "ChainIncrease":"17",
              "Date":"20160604"
          }
      ]
    }

应答包字段说明

字段 类型 说明
Result Array 请求最近30天的运营数据
ErrorCode Integer 错误码,0表示成功,非0表示失败
ErrorInfo String 错误信息

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:

错误码 含义说明
130001 请求包 JSON 解析错误
130009 SQL Open 错误
130010 SQL Ping 错误
130011 SQL 查询错误
130012 SQL 结果解析错误

可拉取的运营字段

字段 说明
AppName 应用名称
AppId 应用 SDKAppID
Company 所属客户名称
ActiveUserNum 活跃用户数
RegistUserNumOneDay 新增注册人数
RegistUserNumTotal 累计注册人数
LoginTimes 登录次数
LoginUserNum 登录人数
UpMsgNum 上行消息数
DownMsgNum 下行消息数
SendMsgUserNum 发消息人数
APNSMsgNum APNs 推送数
C2CUpMsgNum 上行消息数(C2C)
C2CDownMsgNum 下行消息数(C2C)
C2CSendMsgUserNum 发消息人数(C2C)
C2CAPNSMsgNum APNs 推送数(C2C)
MaxOnlineNum 最高在线人数
ChainIncrease 关系链对数增加量
ChainDecrease 关系链对数删除量
GroupUpMsgNum 上行消息数(群)
GroupDownMsgNum 下行消息数(群)
GroupSendMsgUserNum 发消息人数(群)
GroupAPNSMsgNum APNs 推送数(群)
GroupSendMsgGroupNum 发消息群组数
GroupJoinGroupTimes 入群总数
GroupQuitGroupTimes 退群总数
GroupNewGroupNum 新增群组数
GroupAllGroupNum 累计群组数
GroupDestroyGroupNum 解散群个数
CallBackReq 回调请求数
CallBackRsp 回调应答数
Date 日期

接口调试工具

通过 REST API 在线调试工具调试本接口。