# Preface
The Digital Center OpenAPI is a set of core interface endpoints exposed by the FinClip server. It allows you to interact with the FinClip server programmatically for automating tasks, integrating with other tools, and creating custom workflows.
# Quick Start
- In the Digital Center personal center, select to create a Personal Access Token.
- Check the permissions required for the current Token and create it. Note: Please keep the generated Access Token safe as it cannot be retrieved afterward and can only be reset.
- Choose any of the following OpenAPI interfaces and embed the Authorization header in the request header, with the value: Bearer {PersonalAccessToken}
- Note: This header is a required parameter for all OpenAPI interfaces

- Note: This header is a required parameter for all OpenAPI interfaces
# Authorization Scope
Authorization scope refers to the set of OpenAPI permissions.
Below are detailed explanations of specific authorization scopes.
| Authorization Group | Authorization Scope | Description |
|---|---|---|
| User | User-View | View users in the Digital Center |
| User-Edit | Invite & Remove users from the Digital Center | |
| Role-View | View roles and their permissions defined in the system | |
| Role-Edit | Edit role permissions and assign roles to members | |
| Ecosystem | Ecosystem-View | View organization & account-related information in the Developer Center |
| Ecosystem-Edit | Manage organization & account-related information in the Developer Center | |
| Mini-Program | Mini-Program-View | View basic information of Mini-Programs |
| Mini-Program Unified Authentication | Interfaces related to unified authentication for Mini-Programs |
# API
The following OpenAPI interfaces are categorized by authorization scope, and only Personal Access Tokens with the corresponding authorization scope can access specific interfaces.
# 1. General Interfaces
General interfaces refer to OpenAPIs that do not depend on any authorization scope, mainly covering some basic functionalities related to user accounts.
# 1.1 Get Permission Tree
Request URL
GET /api/v1/open/oper/auth/tree
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters None
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"permissionTree": { // Permission tree
"childrenIds": [
""
],
"desc": "",
"exist": true,
"hasPermission": true,
"id": "",
"itemType": 1,
"name": "",
"parentId": ""
}
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 1.2 Decrypt String
Request URL
POST /api/v1/open/oper/decrypt
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
| Field | Type | Meaning |
|---|---|---|
| str | string | String to decrypt |
Request Example
{
"str": "42b0ec79222a3a95577a86883890dc24ddcc6f7feec88b01f9ec22326e27f2c4"
}
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"str": "Decrypted result"
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 2. User-View
# 2.1 Get Account Role List
Request URL
GET /api/v1/open/oper/account/role/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: query
| Field | Type | Meaning |
|---|---|---|
| accountId | string | |
| pageNo | int | Page number. Starts from 1 |
| pageSize | int | Number of items per page |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"items": {
"builtinRoleKey": "", // Key of built-in roles, existing ones: admin, data_analyst, developer, super_admin
"name": "", // Role name
"roleId": "" // Role ID
},
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 2.2 Get Account List
Request URL
GET /api/v1/open/oper/account/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: query
| Field | Type | Meaning |
|---|---|---|
| pageNo | int | Page number. Starts from 1 |
| pageSize | int | Number of items per page |
| keyword | string | Keyword for fuzzy search of accounts |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"accounts": {
"account": "", // Account name
"accountId": "", // Account ID
"createTime": 1, // Creation time
"email": "", // Email
"phone": "", // Phone number
"status": 1 // Status 1=Enabled 2=Disabled
}
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 3. User-Edit
# 3.1 Bind Roles to Account
Note Each request contains the full list of roles, which will delete old relationships.
Request URL
POST /api/v1/open/oper/account/role/binding
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
| Field | Type | Meaning |
|---|---|---|
| accountId | string | Account ID |
| roleIds | string[] | List of role IDs |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 3.2 Update User Frozen Status
Request URL
POST /api/v1/open/oper/account/frozen/update
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter location: body
| Field | Type | Meaning |
|---|---|---|
| isFrozen | int | Whether frozen 0=Unfreeze 1=Frozen |
| operAccountId | string | Digital Center user ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 3.3 Reset Password
Request URL
POST /api/v1/open/oper/account/password/reset
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Meaning |
|---|---|---|
| accountId | string | Account ID |
| password | string | New password |
Sample Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 3.4 Create Account
Request URL
POST /api/v1/open/oper/account/create
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Meaning |
|---|---|---|
| phone | string | Phone number |
| roleIds | string[] | Bound role IDs |
| account | string | Account name |
| areaCode | string | Phone area code, example +86 |
| string | ||
| password | string | Password |
Sample Response
{
"error": "",
"errcode": "OK",
"data": {
"accountId": ""
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 3.5 Delete Account
Request URL
POST /api/v1/open/oper/account/delete
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Meaning |
|---|---|---|
| accountIds | string[] | Account IDs |
Sample Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 4. Role - View
# 4.1 Get Role List
Request URL
GET /api/v1/open/oper/role/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Meaning |
|---|---|---|
| pageNo | int | Page number. Starts from 1 |
| pageSize | int | Number of items per page |
| keyword | string | Role name fuzzy search keyword |
Sample Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 4.2 Get Account List Under a Role
Request URL
GET /api/v1/open/oper/role/account/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Meaning |
|---|---|---|
| roleId | string | Role ID |
| pageNo | int | Page number. Starts from 1 |
| pageSize | int | Number of items per page |
Sample Response
{
"error": "",
"errcode": "OK",
"data": {
"accounts": {
"account": "", // Account name
"accountId": "", // Account ID
"createTime": 1, // Account creation time
"email": "", // Email
"phone": "" // Phone number
},
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 5. Role - Edit
# 5.1 Update Role
Request URL
POST /api/v1/open/oper/role/update
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Meaning |
|---|---|---|
| idePermissionTree | map<string, object> | IDE permission tree |
| permissionTree | map<string, object> | Permission tree |
| roleId | string |
Sample Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 5.2 Delete Role
Request URL
POST /api/v1/open/oper/role/delete
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Meaning |
|---|---|---|
| roleId | string | Role ID |
Sample Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 5.3 Remove Accounts from Role
Request URL
POST /api/v1/open/oper/role/account/delete
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Meaning |
|---|---|---|
| accountIds | string[] | Member ID list |
| roleId | string | Role ID |
Sample Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 5.4 Create Role
Request URL
POST /api/v1/open/oper/role/create
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| idePermissionTree | object | IDE Permission Tree |
| permissionTree | object | Permission Tree |
| roleName | string | Role Name |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"roleId": ""
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 5.5 Bind Accounts to Roles
Note Each incoming request contains an incremental member list, and old relationships will not be deleted.
Request URL
POST /api/v1/open/oper/role/account/binding
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Description |
|---|---|---|
| accountIds | string[] | List of Member IDs |
| roleId | string | Role ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 6. Ecosystem - View
# 6.1 Get the List of Organizations Joined by Developer Accounts
Request URL
GET /api/v1/open/oper/dev-account/ecology/organ/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| devAccountId | string | Account ID |
| pageNo | int | Page number (starting from 1) |
| pageSize | int | Number of items per page |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"items": {
"organId": "",
"organName": "",
"reviewStatus": 1,
"role": ""
},
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 6.2 Get the List of Developer Accounts
Request URL
GET /api/v1/open/oper/dev-account/ecology/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| organId | string | Organization ID filter |
| organName | string | Organization name filter |
| pageNo | int | Page number (starting from 1) |
| pageSize | int | Number of items per page |
| search | string | Keyword for fuzzy search of accounts |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"items": {
"account": "",
"createTime": 1,
"devAccountId": "",
"email": "",
"organCount": 1,
"phone": ""
},
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 6.3 Get Developer Organization Details
Request URL
GET /api/v1/open/oper/organ/ecology/info
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| devOrganId | string | Organization ID |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"access": true,
"applyTime": 1,
"devOrganAuditRecordId": "",
"enterpriseInfo": "",
"enterpriseName": "",
"enterpriseType": "",
"operReviewResult": 1,
"rejectReason": "",
"reviewerId": "",
"workflowNodeInstanceId": ""
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 6.4 Get the List of Developer Organizations
Request URL
GET /api/v1/open/oper/organ/ecology/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| enterpriseType | string | Subtype filter for certified organizations |
| organName | string | Organization name filter |
| organReviewStatus | string | |
| pageNo | int | Page number (starting from 1) |
| pageSize | int | Number of items per page |
| type | int | Organization type. 1 = Uncertified Organization, 2 = Certified Organization |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"items": {
"applyPassTime": 1,
"createTime": 1,
"devOrganId": "",
"enterpriseType": "",
"name": "",
"reviewStatus": 1,
"type": 1
},
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 6.5 Get Developer Account Details
Request URL
GET /api/v1/open/oper/dev-account/ecology/get
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: query
| Field | Type | Description |
|---|---|---|
| devAccountId | string | Developer Account ID |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"devAccountId": "2309190000000000",
"account": "Baoshu",
"email": "test@gmail.com",
"phone": "13000000000",
"areaCode": "+86"
},
"traceid": "a0560a999f6f41f8af00a661264fd0d0"
}
# 7. Ecosystem - Edit
# 7.1 - Reset Developer Account Password
Request URL
POST /api/v1/open/oper/dev-account/ecology/reset/password
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Meaning |
|---|---|---|
| devAccountId | string | Account ID |
| password | string | Password |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 7.2 Update Enterprise Freeze Status
Request URL
POST /api/v1/open/oper/organ/ecology/frozen-status/update
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Meaning |
|---|---|---|
| devOrganId | string | Organization ID |
| isFrozen | int | Freeze status 1=Not frozen 2=Frozen |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 7.3 Update Enterprise Review Status
Request URL
POST /api/v1/open/oper/organ/ecology/review-status/update
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Meaning |
|---|---|---|
| devOrganId | string | Organization ID |
| operReviewResult | int | |
| rejectReason | string | Rejection reason |
| workflowNodeInstanceId | string | Node instance ID |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 7.4 Add Developer Center Member Account
Request URL
POST /api/v1/open/oper/dev-account/ecology/create
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Meaning |
|---|---|---|
| account | string | Account name |
| areaCode | string | Phone area code |
| string | ||
| password | string | Password |
| phone | string | Phone number |
Example Response
{
"errcode": "",
"error": "",
"data": {},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 7.5 Check Mini-Program Permissions
Request URL
POST /api/v1/open/oper/resource-groups/mini-app/check
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters Parameter Location: body
| Field | Type | Meaning |
|---|---|---|
| accountId | string | Account ID |
| miniAppId | string | Mini-Program ID |
Request Example
{
"accountId": "2309190518932677",
"miniAppId": "fc2524431909802053"
}
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"hasPermission": true // Whether permission exists
},
"traceid": "63500886a1f541249545fc0afbc52394"
}
# 8. Mini-Program - View
# 8.1 Get Mini-Program Details
Request URL
GET /api/v1/open/oper/mini-apps/{miniAppId}
Request Parameters Parameter Location: path
| Field | Type | Meaning |
|---|---|---|
| miniAppId | string | Mini-Program ID |
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"appClass": "", // Mini-Program category
"appClassKey": "", // Mini-Program category key
"createBy": "", // Creator
"createTime": 1, // Creation time
"creatorAccount": "", // Creator account
"desc": "", // Mini-Program description
"detailDesc": "", // Detailed description of the Mini-Program
"displayLang": "", // Display language of the Mini-Program
"isForbidden": true, // Whether it is disabled
"logo": "", // Mini-Program logo
"miniAppId": "", // Mini-Program ID
"name": "", // Mini-Program name
"organId": "", // Organization ID to which the Mini-Program belongs
"organName": "", // Organization name to which the Mini-Program belongs
"privacySettingType": 1, // Privacy settings status of the Mini-Program. 0=Not set 1=Custom content set 2=Default content set
"projectType": 1, // Mini-Program subtype. 1=Mini-Program 2=Mini-Game 3=h5 4=Widget 5=Low-power
"searchable": true, // Whether search is allowed
"status": 1, // Current lifecycle status of the Mini-Program. 1=In development, no code package uploaded 2=On-shelf review in progress 3=On-shelf review withdrawn 4=On-shelf review passed 5=On-shelf review rejected 6=On shelf 7=Off shelf (initiated by developer) 8=Off shelf (by admin) 9=In development, only code package uploaded 10=Creation review in progress 11=Creation review withdrawn 12=Creation review rejected
"testInfo": 1, // Mini-Program test information
"updateTime": 1, // Update time
"version": "" // Published version number
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 8.2 Get the List of Host-Apps Associated with the Mini-Program
Request URL
GET /api/v1/open/oper/mini-apps/{miniappid}/host-apps
Request Parameters Parameter Location: query
| Field | Type | Meaning |
|---|---|---|
| miniAppId | string | |
| pageNo | int | |
| pageSize | int |
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Example Response
{
"error": "",
"errcode": "OK",
"data": {
"items": {
"bundleIdPublic": true,
"createTime": 1,
"desc": "",
"displayLang": "",
"hostAppId": "",
"hostAppPublic": true,
"isBuiltin": true,
"logo": "",
"name": "",
"organId": "",
"organName": "",
"owner": "",
"platform": 1,
"source": 1,
"status": 1,
"updateTime": 1
},
"total": 1
},
"traceid": "a17b2855affb46c08485937aca8243ef"
}
# 9. Analysis
# 9.1 Get Mini-Program List
Request URL
GET /api/v1/open/oper/mini-apps/list
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| appStatus | integer | No | query | Mini-Program status |
| applyEndTime | integer | No | query | Application time - End range |
| applyStartTime | integer | No | query | Application time - Start range |
| exportId | string | No | query | Export task ID |
| frozenStatus | integer | No | query | Freeze status (0 All, 1 Normal, 2 Frozen) |
| isExport | boolean | No | query | Whether to export data |
| keyword | string | No | query | Keyword |
| organId | string | No | query | Enterprise ID |
| organName | string | No | query | Enterprise name fuzzy match |
| pageNo | integer | No | query | Page number |
| pageSize | integer | No | query | Number of items per page |
| projectType | string | No | query | Project type (multi-select separated by commas) |
| publishEndTime | integer | No | query | Publish time - End range |
| publishStartTime | integer | No | query | Publish time - Start range |
| sortType | string | No | query | Sort type |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.applyTime | integer | Application time |
| items.assignees | array | List of assignees |
| items.auditStatus | integer | Audit status |
| items.createTime | integer | Creation time |
| items.miniAppId | string | Mini-Program ID |
| items.name | string | Name |
| items.organId | string | Enterprise ID |
| items.organName | string | Enterprise name |
| items.projectType | integer | Project type |
| items.publishStatus | integer | Publish status |
| items.publishTime | integer | Publish time |
| total | integer | Total count |
Example Response
{
"items": [
{
"applyTime": 1704067200000,
"assignees": ["Zhang San"],
"auditStatus": 1,
"createTime": 1704067200000,
"miniAppId": "123456",
"name": "Sample Mini-Program",
"organId": "789",
"organName": "Test Enterprise",
"projectType": 1,
"publishStatus": 2,
"publishTime": 1704067200000
}
],
"total": 100
}
# 9.2 Data Dashboard - Total PV
Request URL
GET /api/v1/open/oper/stat/basic/billboard/total/pv
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| devOrganIds | string | No | query | Organization IDs |
| endTime | integer | No | query | End time |
| exportId | string | No | query | Export ID |
| isExport | boolean | No | query | Whether to export data |
| metricType | integer | No | query | Metric type |
| miniAppIds | string | No | query | Mini-Program IDs |
| pageNo | integer | No | query | Page number |
| pageSize | integer | No | query | Number of items per page |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| hasData | boolean | Whether data exists |
| items | array | List of data items |
| items.activeDeviceCount | integer | Active device count |
| items.date | string | Date |
| items.dateMs | integer | Date timestamp (ms) |
| items.deviceCount | integer | Device count |
| items.duration | integer | Usage duration (seconds) |
| items.existCount | integer | Existing count |
| items.formattedDuration | string | Formatted duration |
| items.miniAppId | string | Mini-Program ID |
| items.name | string | Name |
| items.openCount | integer | Open count |
| total | integer | Total count |
Example Response
{
"hasData": true,
"items": [
{
"activeDeviceCount": 100,
"date": "2024-01-01",
"dateMs": 1704067200000,
"deviceCount": 500,
"duration": 3600,
"existCount": 200,
"formattedDuration": "1 hour",
"miniAppId": "123456",
"name": "Sample Mini-Program",
"openCount": 1000
}
],
"total": 100
}
# 9.3 Get Mini-Program Statistics Line Chart
Request URL
GET /api/v1/open/oper/stat/basic/mini-app/pillar
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| endTime | integer | No | query | Gray release end time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Gray release start time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.activeDeviceCount | integer | Active device count |
| items.date | string | Date |
| items.dateMs | integer | Date timestamp (ms) |
| items.deviceCount | integer | Device count |
| items.duration | integer | Usage duration (seconds) |
| items.newDeviceCount | integer | New device count |
| items.openCount | integer | Open count |
| items.val | integer | Value |
| maxTotal | integer | Maximum total |
Example Response
{
"items": [
{
"activeDeviceCount": 100,
"date": "2024-01-01",
"dateMs": 1704067200000,
"deviceCount": 500,
"duration": 3600,
"newDeviceCount": 50,
"openCount": 200,
"val": 1000
}
],
"maxTotal": 5000
}
# 9.4 Data Dashboard - Total Average Visit Duration
Request URL
GET /api/v1/open/oper/stat/basic/billboard/total/avg-duration
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| country | string | No | query | Country |
| devOrganIds | string | No | query | Organization IDs |
| endTime | integer | No | query | End time |
| exportId | string | No | query | Export identifier |
| isExport | boolean | No | query | Whether to export data |
| isRunPlay | boolean | No | query | Whether run play |
| miniAppIds | string | No | query | Mini-Program IDs |
| startTime | integer | No | query | Start time |
Response Parameters
...
| Parameter Name | Type | Description |
|---|---|---|
| hasData | boolean | Whether there is data |
| items | array | List of data items |
| items.date | string | Date |
| items.dateMs | integer | Date timestamp (milliseconds) |
| items.formattedVal | string | Formatted value |
| items.val | integer | Numeric value |
| totalCount | integer | Total count |
Example Response
{
"hasData": true,
"items": [
{
"date": "2024-01-01",
"dateMs": 1704067200000,
"formattedVal": "1,000",
"val": 1000
}
],
"totalCount": 30
}
# 9.5 Data Dashboard - Total Active Devices
Request URL
GET /api/v1/open/oper/stat/basic/billboard/total/active-device
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| country | string | No | query | Country |
| devOrganIds | string | No | query | Organization IDs |
| endTime | integer | No | query | End time |
| exportId | string | No | query | Export identifier |
| isExport | boolean | No | query | Whether to export |
| isRunPlay | boolean | No | query | Whether run play |
| miniAppIds | string | No | query | Mini-Program IDs |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| hasData | boolean | Whether there is data |
| items | array | List of data items |
| items.date | string | Date |
| items.dateMs | integer | Date timestamp (milliseconds) |
| items.formattedVal | string | Formatted value |
| items.val | integer | Numeric value |
| totalCount | integer | Total count |
Example Response
{
"hasData": true,
"items": [
{
"date": "2024-01-01",
"dateMs": 1704067200000,
"formattedVal": "1,000",
"val": 1000
}
],
"totalCount": 30
}
# 9.6 Data Dashboard - Total UV
Request URL
GET /api/v1/open/oper/stat/basic/billboard/total/uv
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| country | string | No | query | Country |
| devOrganIds | string | No | query | Organization IDs |
| endTime | integer | No | query | End time |
| exportId | string | No | query | Export identifier |
| isExport | boolean | No | query | Whether to export |
| isRunPlay | boolean | No | query | Whether run play |
| miniAppIds | string | No | query | Mini-Program IDs |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| hasData | boolean | Whether there is data |
| items | array | List of data items |
| items.date | string | Date |
| items.dateMs | integer | Date timestamp (milliseconds) |
| items.formattedVal | string | Formatted value |
| items.val | integer | Numeric value |
| totalCount | integer | Total count |
Example Response
{
"hasData": true,
"items": [
{
"date": "2024-01-01",
"dateMs": 1704067200000,
"formattedVal": "1,000",
"val": 1000
}
],
"totalCount": 30
}
# 9.7 Data Dashboard - Host-App Sources
Request URL
GET /api/v1/open/oper/stat/basic/billboard/host-app
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| country | string | No | query | Country |
| devOrganIds | string | No | query | Organization IDs |
| endTime | integer | No | query | End time |
| exportId | string | No | query | Export identifier |
| isExport | boolean | No | query | Whether to export |
| isRunPlay | boolean | No | query | Whether run play |
| miniAppIds | string | No | query | Mini-Program IDs |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Numeric value |
Example Response
{
"items": [
{
"formattedVal": "1,000",
"name": "App Name",
"proportion": "50%",
"value": 1000
}
]
}
# 9.8 Data Dashboard - Regional Distribution
Request URL
GET /api/v1/open/oper/stat/basic/billboard/country/region
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| country | string | No | query | Country |
| devOrganIds | string | No | query | Organization IDs |
| endTime | integer | No | query | End time |
| exportId | string | No | query | Export identifier |
| isExport | boolean | No | query | Whether to export |
| isRunPlay | boolean | No | query | Whether run play |
| miniAppIds | string | No | query | Mini-Program IDs |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Numeric value |
Example Response
{
"items": [
{
"formattedVal": "1,000",
"name": "Beijing",
"proportion": "50%",
"value": 1000
}
]
}
# 9.9 Device Data - Get Mini-Program Retention Statistics
Request URL
GET /api/v1/open/oper/stat/basic/mini-app/retention
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| endTime | integer | No | query | End time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.date | string | Date |
| items.dateMs | integer | Timestamp in milliseconds |
| items.five | integer | 5-day retention |
| items.formattedVal | string | Formatted value |
| items.four | integer | 4-day retention |
| items.fourteen | integer | 14-day retention |
| items.newUserCount | integer | Number of new users |
| items.one | integer | Next-day retention |
| items.seven | integer | 7-day retention |
| items.six | integer | 6-day retention |
| items.thirty | integer | 30-day retention |
| items.three | integer | 3-day retention |
| items.two | integer | 2-day retention |
| items.val | integer | Value |
Sample Response
{
"items": [
{
"date": "2024-01-01",
"dateMs": 1704067200000,
"five": 100,
"formattedVal": "1,000",
"four": 120,
"fourteen": 80,
"newUserCount": 1000,
"one": 500,
"seven": 200,
"six": 150,
"thirty": 50,
"three": 300,
"two": 400,
"val": 1000
}
]
}
# 9.10 Device Data - Get Mini-Program Statistics Line Chart
Request URL
GET /api/v1/open/oper/stat/basic/mini-app/pillar
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| endTime | integer | No | query | End time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.activeDeviceCount | integer | Number of active devices |
| items.date | string | Date |
| items.dateMs | integer | Timestamp in milliseconds |
| items.deviceCount | integer | Number of devices |
| items.duration | integer | Usage duration (seconds) |
| items.newDeviceCount | integer | Number of new devices |
| items.openCount | integer | Number of opens |
| items.val | integer | Value |
| maxTotal | integer | Maximum total |
Sample Response
{
"items": [
{
"activeDeviceCount": 100,
"date": "2024-01-01",
"dateMs": 1704067200000,
"deviceCount": 500,
"duration": 3600,
"newDeviceCount": 50,
"openCount": 200,
"val": 1000
}
],
"maxTotal": 5000
}
# 9.11 Device Data - Get Mini-Program Device Distribution
Request URL
GET /api/v1/open/oper/stat/basic/mini-app/device
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| endTime | integer | No | query | End time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Value |
Sample Response
{
"items": [
{
"formattedVal": "1,000",
"name": "iOS",
"proportion": "50%",
"value": 1000
}
]
}
# 9.12 Device Data - Get Mini-Program Screen Resolution Distribution
Request URL
GET /api/v1/open/oper/stat/basic/mini-app/screen
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| endTime | integer | No | query | End time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Value |
Sample Response
{
"items": [
{
"formattedVal": "1,000",
"name": "1920x1080",
"proportion": "50%",
"value": 1000
}
]
}
# 9.13 Device Data - Get Mini-Program Mobile Brand Distribution
Request URL
GET /api/v1/open/oper/stat/basic/mini-app/brand
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| endTime | integer | No | query | End time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Value |
Sample Response
{
"items": [
{
"formattedVal": "1,000",
"name": "Huawei",
"proportion": "50%",
"value": 1000
}
]
}
# 9.14 Device Data - Get Mini-Program SDK Version Distribution
Request URL
GET /api/v1/open/oper/stat/basic/mini-app/sdk-version
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| endTime | integer | No | query | End time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Value |
Sample Response
{
"items": [
{
"formattedVal": "1,000",
"name": "v3.0.0",
"proportion": "50%",
"value": 1000
}
]
}
# 9.15 Device Data - Get Mini-Program Base Package Version Distribution
Request URL
GET /api/v1/open/oper/stat/basic/mini-app/basic-pack-version
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| endTime | integer | No | query | End time |
| miniAppId | string | No | query | Mini-Program ID |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Value |
Sample Response
{
"items": [
{
"formattedVal": "1,000",
"name": "v1.0.0",
"proportion": "50%",
"value": 1000
}
]
}
# 9.16 Data Dashboard - Regional Application Source Distribution
Request URL
GET /api/v1/open/oper/stat/basic/billboard/region
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer {PersonalAccessToken} |
Request Parameters
| Parameter Name | Type | Required | Position | Description |
|---|---|---|---|---|
| country | string | No | query | Country |
| devOrganIds | string | No | query | Organization IDs |
| endTime | integer | No | query | End time |
| exportId | string | No | query | Export identifier |
| isExport | boolean | No | query | Whether to export |
| isRunPlay | boolean | No | query | Whether run play |
| miniAppIds | string | No | query | Mini-Program IDs |
| startTime | integer | No | query | Start time |
Response Parameters
| Parameter Name | Type | Description |
|---|---|---|
| items | array | List of data items |
| items.formattedVal | string | Formatted value |
| items.name | string | Name |
| items.proportion | string | Proportion |
| items.value | integer | Value |
Sample Response
{
"items": [
{
"formattedVal": "1,000",
"name": "East China",
"proportion": "50%",
"value": 1000
}
]
}
# Common Error Codes
The following defines a dictionary of common error codes used across interfaces for return value judgment and error troubleshooting.
| errcode Error Code | Description |
|---|---|
| OK | Success |
| ECODE_PARAM_ERR | Parameter error. The request parameters are invalid; check the request input |
| ECODE_UNAUTHORIZED | Unauthorized. Unable to identify the user; check if the PersonalAccessToken is correct |
| ECODE_FORBIDDEN | Not authorized. The permissions associated with the current PersonalAccessToken are insufficient to access the requested interface |
| ECODE_SERVER_ERR | Internal server error. An unexpected error occurred; please report the issue to the system administrator with the traceid from the response |
| ECODE_LICENSE_NOT_SUPPORT_OPEN_API_ERROR | The current license does not support the open-api feature and cannot be used |
| OPEN_API_ACCESS_TOKEN_NOT_FOUND_ERR | The current PersonalAccessToken does not exist |
| ECODE_PERSONAL_ACCESS_TOKEN_CROSS_PLATFORM_ERROR | Using the PersonalAccessToken from the Developer Center or Digital Center to access an interface on the other platform |
| ECODE_PERSONAL_ACCESS_TOKEN_OUT_OF_SCOPE | Unable to identify the user; check if the current PersonalAccessToken is correct |
| ECODE_PERSONAL_ACCESS_TOKEN_OUT_OF_SCOPE | The permissions associated with the current PersonalAccessToken are insufficient to access the requested interface |