please select
  • UIKit
  • SDK
  • Server APIs
Chat/
Server APIs/
RESTful APIs/
Operations Management/
Server APIs
  • Generating UserSig
  • RESTful APIs
    • RESTful API Overview
    • RESTful API List
    • Message Related
      • Send Message
        • Sending One-to-One Messages to One User
        • Sending One-to-One Messages to Multiple Users
        • Sending Ordinary Messages in a Group
        • Sending System Messages in a Group
        • Broadcast Message of Audio-Video Group
        • Importing One-to-One Messages
        • Importing Group Messages
      • Historical Message
        • Modifying Historical One-to-one Messages
        • Modifying Historical Group Messages
        • Pulling Historical One-to-one Messages
        • Pulling Historical Group Messages
      • Delete Message
        • Deleting Messages Sent by a Specified User
      • Withdraw Message
        • Recalling One-to-One Messages
        • Recalling Group Messages
      • Read Receipt
        • Marking One-to-One Messages as Read
        • Pulling Group Message Read Receipt Details
        • Pulling Read Receipts for Group Messages
      • Message Extension
        • Pulling the Message Extension of a One-to-One Message
        • Configuring Message Extension for a One-to-One Message
        • Pulling Message Extension of a Group Message
        • Configuring Message Extension for a Group Message
      • Pushing to All Users
        • API for Pushing to All Users
        • Pushing to All Users
        • Setting Application Attribute Names
        • Getting Application Attribute Names
        • Getting User Attributes
        • Setting User Attributes
        • Deleting User Attributes
        • Getting User Tags
        • Adding User Tags
        • Deleting User Tags
        • Deleting All Tags of a User
    • Session Related
      • Conversation List
        • Pulling a conversation list
      • Session Unread Count
        • Setting the Unread Message Count of a Member
        • Querying Unread One-to-One Message Count
      • Delete Session
        • Deleting a conversation
      • Session Grouping Tag
        • Creating Conversation Group Data
        • Updating Conversation Group Data
        • Deleting Conversation Group Data
        • Creating or Updating Conversation Mark Data
        • Searching for Conversation Group Marks
        • Pulling Conversation Group Mark Data
    • Group Related
      • Group Management
        • Getting All Groups in an App
        • Creating a Group
        • Disbanding a Group
        • Getting the Groups a User Has Joined
      • Group Information
        • Getting Group Profiles
        • Modifying the Profile of a Group
        • Importing a Group Profile
      • Group Member Management
        • Adding Group Members
        • Deleting Group Members
        • Banning Group Members
        • Unbanning Group Members
        • Bulk Muting and Unmuting
        • Getting the List of Muted Group Members
        • Changing Group Owner
        • Querying the Roles of Users in a Group
        • Importing Group Members
      • Group Member Information
        • Getting Group Member Profiles
        • Modifying the Profile of a Group Member
      • Group Custom Attributes
        • Getting Group Custom Attributes
        • Modifying Group Custom Attributes
        • Clearing Group Custom Attributes
        • Resetting Group Custom Attributes
        • Deleting Group Custom Attributes
      • Live Group Management
        • Getting the Number of Online Users in an Audio-Video Group
        • Getting the List of Online Members in Audio-Video Group
        • Setting Audio-Video Group Member Marks
        • Getting the List of Banned Group Members.
      • Community Management
        • Creating Topic
        • Deleting Topic
        • Getting Topic Profile
        • Modifying Topic Profile
        • Importing Topic Profiles
      • Group Counter
        • Getting Group Counters
        • Updating Group Counters
        • Deleting Group Counters
    • User Management
      • Account Management
        • Importing a Single Account
        • Importing Multiple Accounts
        • Deleting Accounts
        • Querying Accounts
      • User Information
        • Setting Profiles
        • Pulling Profiles
      • User Status
        • Invalidating Account Login States
        • Querying Account Online Status
      • Friend Management
        • Adding Friends
        • Importing Friends
        • Updating Friends
        • Deleting Friends
        • Deleting All Friends
        • Verifying Friends
        • Pulling Friends
        • Pulling Specified Friends
      • Friend Lists
        • Adding Lists
        • Deleting Lists
        • Pulling Lists
      • Blocklist
        • Blocklisting Users
        • Unblocklisting Users
        • Pulling a Blacklist
        • Verifying Users on a Blocklist
    • Global Mute Management
      • Setting Global Mute
      • Querying Global Mute
    • Operations Management
      • Pulling Operations Data
      • Downloading Recent Messages
      • Getting Server IP Addresses
    • Chatbots
      • Pulling Chatbot Accounts
      • Creating Chatbot Accounts
      • Deleting Chatbot Accounts
  • Webhooks
    • Webhook Overview
    • Webhook Command List
    • Operations Management Callbacks
      • API Overclocking Alarm Callbacks
    • Online Status Webhooks
      • Status Change Webhooks
    • Relationship Chain Webhooks
      • After a Profile Is Updated
      • Before a Friend Is Added
      • Before a Friend Request Is Responded
      • After a Friend Is Added
      • After a Friend Is Deleted
      • After a User Is Added to Blocklist
      • After a User Is Removed from Blocklist
    • One-to-One Message Webhooks
      • Before a One-to-One Message Is Sent
      • After a One-to-One Message Is Sent
      • After a One-to-One message Is Marked as Read
      • After A One-to-One Message Is Recalled
    • Group Webhooks
      • Before a Group Is Created
      • After a Group Is Created
      • Before Applying to Join a Group
      • Before Inviting a User to a Group
      • After a User Joins a Group
      • After a User Leaves a Group
      • Before Group Message Is Sent
      • After a Group Message Is Sent
      • After a Group Is Full
      • After a Group Is Disbanded
      • After Group Profile Is Modified
      • Callback After Recalling Group Messages
      • Webhook for Online and Offline Status of Audio-Video Group Members
      • Webhook for Exceptions When Group Messages Are Sent
      • Before a Topic Is Created
      • After a Topic Is Created
      • After a Topic Is Deleted
      • Topic Profile Change Webhook
      • Callback After Group Member Profile Changed
      • Callback After Group Attribute Changed
      • Callback After Read Receipt
      • Callback After the Group Owner Changed
    • Webhook Mutual Authentication Configuration Guide
      • Apache Mutual Authentication Configuration
      • Nginx Mutual Authentication Configuration
    • Chatbot webhooks
      • Chatbot Passthrough Message Callback
Docs Overview/
Chat/
Server APIs/
RESTful APIs/
Operations Management/
Pulling Operations Data/

Pulling Operations Data

Feature Overview

The app admin can pull operations data for the last 30 days through this API. The operational data fields that can be pulled are described later in this document.

API Calling Description

Sample request URL

https://xxxxxx/v4/openconfigsvr/getappinfo?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request parameters

The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
Parameter
Description
xxxxxx
Domain name corresponding to the country/region where your SDKAppID is located.
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
Seoul: adminapikr.im.qcloud.com
Frankfurt: adminapiger.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/openconfigsvr/getappinfo
Request API
sdkappid
SDKAppID assigned by the Chat console when an app is created
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
usersig
Signature generated by the app admin account. For details, see Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Request format. The value is fixed to json.

Maximum call frequency

200 calls per second

Sample request

Query the operations data of the last 30 days for SDKAppID.
Basic format Pull all fields by default.
{}
Specifying fields to be pulled Specify fields to be pulled in RequestField.
{
  "RequestField":[
      "ChainIncrease",
      "ChainDecrease"
  ]
}

Request fields

Field
Type
Required
Description
RequestField
Array
No
This field is used to specify the operations data fields to be pulled. If this field is not specified, all fields will be pulled by default. For details, see the operations data fields that can be pulled below.

Sample response

Basic format
{
  "ErrorCode": 0,
  "ErrorInfo": "OK",
  "Result": [{
      "APNSMsgNum": "84",
      "ActiveUserNum": "2014",
      "AppId": "1104620500",
      "AppName": "Real-Time Communication Scenario Developer edition",
      "C2CAPNSMsgNum": "84",
      "C2CDownMsgNum": "11040",
      "C2CSendMsgUserNum": "9",
      "C2CUpMsgNum": "52209",
      "CallBackReq": "73069",
      "CallBackRsp": "72902",
      "ChainDecrease": "16",
      "ChainIncrease": "18",
      "Company": "Linye",
      "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",
  }]
}
Specifying fields to be pulled
{
  "ErrorCode":0,
  "ErrorInfo":"OK",
  "Result":[{
          "ChainDecrease":"8",
          "ChainIncrease":"8",
          "Date":"20160605"
      },
      {
          "ChainDecrease":"17",
          "ChainIncrease":"17",
          "Date":"20160604"
      }
  ]
}

Response fields

Field
Type
Description
Result
Array
The requested operations data from the last 30 days
ErrorCode
Integer
Error code. 0: Successful; other values: Failed
ErrorInfo
String
Error information

Error Codes

The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ErrorCode and ErrorInfo respectively. For public error codes (60000 to 79999), see Error Codes. The following table describes the error codes specific to this API:
Error Code
Description
130001
JSON parsing error of the request
130009
SQL opening error
130010
SQL pinging error
130011
SQL query error
130012
SQL result parsing error


Operations Data Fields That Can Be Pulled

Field
Description
AppName
App name
AppId
SDKAppID of the app
Company
Customer name
ActiveUserNum
Number of active users
RegistUserNumOneDay
Number of newly registered users
RegistUserNumTotal
Total number of registered users
LoginTimes
Number of logins
LoginUserNum
Number of logged-in users
UpMsgNum
Number of upstream messages
SendMsgUserNum
Number of message sending users
APNSMsgNum
Number of pushed APNs messages
C2CUpMsgNum
Number of upstream messages (C2C)
C2CDownMsgNum
Number of downstream messages (C2C)
C2CSendMsgUserNum
Number of message sending users (C2C)
C2CAPNSMsgNum
Number of pushed APNs messages (C2C)
MaxOnlineNum
Maximum number of online users
DownMsgNum
Total number of downstream messages (C2C and group)
ChainIncrease
Increase in relationship chain pairs
ChainDecrease
Decrease in relationship chain pairs
GroupUpMsgNum
Number of upstream messages (group)
GroupDownMsgNum
Number of downstream messages (group)
GroupSendMsgUserNum
Number of message sending users (group)
GroupAPNSMsgNum
Number of pushed APNs messages (group)
GroupSendMsgGroupNum
Number of message sending groups
GroupJoinGroupTimes
Total number of joined groups
GroupQuitGroupTimes
Total number of left groups
GroupNewGroupNum
Number of newly added groups
GroupAllGroupNum
Total number of groups
GroupDestroyGroupNum
Number of disbanded groups
CallBackReq
Number of callback requests
CallBackRsp
Number of callback responses
Date
Date

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.