Data Types
Last updated:2026-01-16 14:50:44
Data Types
Last updated: 2026-01-16 14:50:44
APPOverview
Superapp data overview
Used by actions: DescribeAPPDataOverview.
| Name | Type | Description |
|---|---|---|
| BaseData | APPOverviewData | No data available Note: This field may return null, indicating that no valid values can be obtained. |
| Overview | APPOverviewData | Superapp overview summary data Note: This field may return null, indicating that no valid values can be obtained. |
| PageData | APPOverviewData | No data available Note: This field may return null, indicating that no valid values can be obtained. |
| Payment | APPOverviewData | No data available Note: This field may return null, indicating that no valid values can be obtained. |
APPOverviewData
Superapp overview data details
Used by actions: DescribeAPPDataOverview.
| Name | Type | Description |
|---|---|---|
| AllActiveDeviceNum | Integer | Superapp active device count |
| AllNewDeviceNum | Integer | Superapp new device count |
| CorpNum | Integer | Mini program team count |
| GameActiveDeviceNum | Integer | Mini game active device count |
| GameNewDeviceNum | Integer | Mini game new device count |
| MiniAppNum | Integer | Created mini program count |
| MngNum | Integer | Created mini game count |
| NewDeviceNum | Integer | Mini program new device count |
| OnlineMiniAppNum | Integer | Released mini program count |
| OnlineMngNum | Integer | Released mini game count |
| VisitNum | Integer | Mini program active device count |
| FlushTime | String | Data refresh timestamp |
AccessAnalysisDetail
Detailed visit analysis data
Used by actions: DescribeGlobalOverviewDataSummary, DescribeMNGAccessAnalysisDetail, DescribeMNGAccessAnalysisOverview, DescribeMNPAccessAnalysisOverview, DescribeMNPReportDetail.
| Name | Type | Description |
|---|---|---|
| ActiveCount | Integer | Number of active devices |
| AvgDevice | String | Average visit duration per user |
| AvgOnce | String | Average visit duration per session |
| AvgOpenCount | String | Average opens per user |
| DataTime | String | Date |
| FlushTime | String | Data time |
| NewCount | Integer | Number of new devices |
| OpenCount | Integer | Number of opens |
| TotalShareNum | Integer | Number of shares |
| TotalUserNum | Integer | Cumulative users |
AccessAnalysisOverview
Overview of mini game visit analysis data
Used by actions: DescribeGlobalOverviewDataSummary, DescribeMNGAccessAnalysisOverview, DescribeMNPAccessAnalysisOverview.
| Name | Type | Description |
|---|---|---|
| BaseData | AccessAnalysisDetail | Overview of visit analysis data Note: This field may return null, indicating that no valid values can be obtained. |
| Overview | Overview | This API does not respond. Note: This field may return null, indicating that no valid values can be obtained. |
| PageData | AccessAnalysisDetail | This API does not respond. Note: This field may return null, indicating that no valid values can be obtained. |
| Payment | AccessAnalysisDetail | This API does not respond. Note: This field may return null, indicating that no valid values can be obtained. |
AdTrendChart
Advertising line chart data
Used by actions: DescribeAdvertisingLineChart, DescribeMNGAdvertisingLineChart.
| Name | Type | Description |
|---|---|---|
| EstimatedEarnings | Array of AnalysisData | Estimated revenue Note: This field may return null, indicating that no valid values can be obtained. |
| RequestsNumber | Array of AnalysisData | Requests Note: This field may return null, indicating that no valid values can be obtained. |
| Impressions | Array of AnalysisData | Impressions Note: This field may return null, indicating that no valid values can be obtained. |
| ECPM | Array of AnalysisData | Effective Cost Per Mille Note: This field may return null, indicating that no valid values can be obtained. |
| ClicksNumber | Array of AnalysisData | Taps Note: This field may return null, indicating that no valid values can be obtained. |
AdvertDataOverview
Advertising data overview
Used by actions: DescribeMNGAdvertisingOverview.
| Name | Type | Description |
|---|---|---|
| EstimatedEarnings | String | Estimated revenue Note: This field may return null, indicating that no valid values can be obtained. |
| RequestsNumber | Integer | Requests Note: This field may return null, indicating that no valid values can be obtained. |
| Impressions | Integer | Impressions Note: This field may return null, indicating that no valid values can be obtained. |
| ClicksNumber | Integer | Taps Note: This field may return null, indicating that no valid values can be obtained. |
| ECPM | String | Impressions Note: This field may return null, indicating that no valid values can be obtained. |
AnalysisAdvertOverview
Advertising analysis data overview
Used by actions: DescribeMNGAdvertisingOverview.
| Name | Type | Description |
|---|---|---|
| OverviewData | AdvertDataOverview | Advertising overview Note: This field may return null, indicating that no valid values can be obtained. |
AnalysisData
Line chart data values
Used by actions: DescribeAdvertisingLineChart, DescribeMNGAdvertisingLineChart.
| Name | Type | Description |
|---|---|---|
| DataTime | String | Time |
| Number | String | Value |
ApplicationConfigInfo
Application configuration info
Used by actions: DescribeApplicationConfigInfos.
| Name | Type | Description |
|---|---|---|
| ApplicationType | Integer | Superapp configuration type: 1 Non-production, 2 Production |
| AppKey | String | Superapp package name |
| AppURL | String | Superapp URL |
| Id | Integer | Superapp configuration ID |
ApprovalItem
Result of the mini program approval requests
Used by actions: ProcessMNPApproval.
| Name | Type | Required | Description |
|---|---|---|---|
| AppId | String | Yes | Application ID |
| ApprovalResult | Integer | Yes | Approval result. 2: Rejected; 3: Approved |
| ApprovalNote | String | No | Approval notes. It’s required when the request is rejected. |
BooleanInfo
Used for Data object when no data is returned after the a successful action.
Used by actions: AddTeamMember, ConfigureMNPPreview, CreateApplicationConfig, CreateApplicationSensitiveAPI, CreateMNPDomainACL, DeleteApplication, DeleteApplicationSensitiveAPI, DeleteMNP, DeleteTeam, DeleteTeamMember, DeleteUser, DisableApplicationSensitiveAPI, EnableApplicationSensitiveAPI, ModifyApplication, ModifyApplicationConfig, ModifyMNPDomain, ModifyTeam, ModifyTeamMember, ModifyUser, ProcessMNPApproval, ProcessMNPSensitiveAPIPermissionApproval, ReleaseMNPVersion, RemoveMNP, RollbackMNPVersion.
| Name | Type | Description |
|---|---|---|
| Result | Boolean | Bool type response object Note: This field may return null, indicating that no valid values can be obtained. |
CreateApplicationSensitiveAPIReq
The request to add a sensitive API
Used by actions: CreateApplicationSensitiveAPI.
| Name | Type | Required | Description |
|---|---|---|---|
| APIName | String | No | API name |
| APIDesc | String | No | API description |
| APIType | Integer | No | API type. 1: system; 2: custom. |
CreateDomainParam
Parameters to create a domain name
Used by actions: CreateMNPDomainACL, ModifyMNPDomain.
| Name | Type | Required | Description |
|---|---|---|---|
| DomainUrlList | Array of String | Yes | Array of domain name URLs |
| DomainType | Integer | Yes | Domain type. 1: requests domain; 2: WebView load domain, 3: sockets domain; 4: File upload; 5: File download |
CreateGlobalDomainResp
Response of creating a global domain name
Used by actions: CreateGlobalDomainACL.
| Name | Type | Description |
|---|---|---|
| Result | Boolean | Result |
| RepeatUrls | Array of String | Indicates the duplicate domain name. |
| ExistsWhiteUrls | Array of String | Lists allowed domain names. |
| ExistsBlackUrls | Array of String | Indicates the domain name already exists in the blocklist. |
CreateMNPApprovalResp
Response for platform review of mini program version submission.
Used by actions: CreateMNPApproval.
| Name | Type | Description |
|---|---|---|
| Result | Boolean | Bool type response object |
| ApprovalNo | String | Approval No. |
CreateMNPVersionResp
Response of creating a mini program version
Used by actions: CreateMNPVersion.
| Name | Type | Required | Description |
|---|---|---|---|
| TaskId | String | No | Specifies the ID of the task to create a mini program version. |
CreateTeamMemberInfoReq
New team member - Member information
Used by actions: AddTeamMember.
| Name | Type | Required | Description |
|---|---|---|---|
| UserId | String | No | User ID |
| UserRoleId | Integer | No | User role ID |
DescribeApplicationConfigInfo
Response data for retrieving superapp configuration information
Used by actions: DescribeApplicationConfigInfos.
| Name | Type | Description |
|---|---|---|
| AndroidConfig | Array of ApplicationConfigInfo | Android configuration list |
| IosConfig | Array of ApplicationConfigInfo | iOS configuration list |
DescribeApplicationListData
Application information
Used by actions: DescribeApplicationList.
| Name | Type | Description |
|---|---|---|
| ApplicationId | String | Application ID |
| AppIdentityId | Integer | App Id. |
| ApplicationName | String | Name |
| Logo | String | Icon |
| Remark | String | Remarks |
| AndroidAppKey | String | Android app package name |
| IosAppKey | String | iOS App bundleId |
| CreateUser | String | Creator |
| CreateTime | String | Creation time |
| UpdateUser | String | Specifies the updater. |
| UpdateTime | String | Update time |
| Intro | String | Introduction |
| TeamId | String | Team Id. |
| TeamName | String | Team name |
| SensitiveApiCount | Integer | Number of sensitive apis. |
| ApplicationType | Integer | Application type. 1: Test; 2: Formal |
DescribeApplicationListResp
List of applications
Used by actions: DescribeApplicationList.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of entries |
| DataList | Array of DescribeApplicationListData | List information |
DescribeApplicationResp
Application details
Used by actions: DescribeApplication.
| Name | Type | Description |
|---|---|---|
| ApplicationId | String | Application ID |
| AppIdentityId | Integer | Product ID. |
| ApplicationName | String | Application name |
| Logo | String | Specifies the application icon. |
| Remark | String | Remarks |
| AndroidAppKey | String | Android package name |
| IosAppKey | String | iOS bundleId |
| CreateUser | String | Creator |
| CreateTime | String | Creation time |
| UpdateUser | String | Specifies the updater. |
| UpdateTime | String | Update time |
| Intro | String | Describes the application description. |
| TeamId | String | Team ID |
| TeamName | String | Team name |
| SensitiveApiCount | Integer | Number of sensitive apis. |
| ApplicationType | Integer | Application type. 1: Test; 2: Formal |
| Scheme | String | Specifies the application Scheme. |
DescribeApplicationSensitiveAPIListData
List of sensitive APIs of an application
Used by actions: DescribeApplicationSensitiveAPIList.
| Name | Type | Description |
|---|---|---|
| APIId | String | APIID |
| APIName | String | API name |
| APIMethod | String | API request method |
| APIDesc | String | API description |
| CreateUser | String | Creator |
| CreateTime | String | Creation time |
| UpdateUser | String | Updater |
| UpdateTime | String | Update time |
| ApplicationId | String | Application ID |
| ApplicationName | String | Application name |
| TeamId | String | Team ID |
| TeamName | String | Team name |
| ApplicationLogo | String | Specifies the application icon. |
| APIType | Integer | API type. 1: system; 2: custom. |
| Status | Integer | API status. 0: public; 1: restricted. |
DescribeApplicationSensitiveAPIListResp
List of sensitive APIs of the application
Used by actions: DescribeApplicationSensitiveAPIList.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of entries |
| DataList | Array of DescribeApplicationSensitiveAPIListData | List information |
DescribeDomainInfoParam
Domain information
Used by actions: DescribeMNPDomainACL.
| Name | Type | Description |
|---|---|---|
| DomainUrl | String | Multiple domain separators ';'. |
| DomainType | Integer | Domain type 1-requests domain 2-business domain. |
DescribeGlobalDomainsListData
List of global domain names
Used by actions: DescribeGlobalDomainACL.
| Name | Type | Description |
|---|---|---|
| DomainId | Integer | Domain ID |
| DomainUrl | String | Domain name |
| DomainType | Integer | Type. 1: allowlist; 2: blocklist. |
| CreateUser | String | Creator |
| CreateTime | String | Creation time |
| UpdateUser | String | Specifies the updater. |
| UpdateTime | String | Update time |
DescribeGlobalDomainsResp
Global domain name page list
Used by actions: DescribeGlobalDomainACL.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number |
| DataList | Array of DescribeGlobalDomainsListData | Describes the domain information. |
DescribeMNPApprovalListData
List of mini program approval requests of the application
Used by actions: DescribeMNPApprovalList.
| Name | Type | Description |
|---|---|---|
| ApprovalNo | String | Approval ticket ID |
| ApplicationId | String | Application ID |
| ApprovalStatus | Integer | Approval status. valid values: 1 (processing), 2 (rejected), 3 (approved), 4 (cancelled). |
| MNPId | String | Mini program ID |
| MNPVersion | String | Mini program version. |
| MNPVersionId | Integer | Mini program version ID |
| ApplyUser | String | Applicant |
| ApplyTime | String | Application time |
| MNPName | String | Mini program name |
| MNPIcon | String | Mini program icon |
| ApplicationName | String | Application name |
| ApplicationLogo | String | Specifies the application icon. |
| TeamId | String | Team ID |
| TeamName | String | Team name |
| MNPQrCodeUrl | String | Mini program review qr code. |
| MNPType | String | Mini program type |
| ApprovalUser | String | Specifies the reviewer. |
| ApprovalTime | String | Approval time. |
| ApprovalNote | String | Approval notes |
DescribeMNPApprovalListResp
List of mini program approval requests of an application
Used by actions: DescribeMNPApprovalList.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of entries |
| DataList | Array of DescribeMNPApprovalListData | List information |
DescribeMNPListData
Mini program list
Used by actions: DescribeMNPList.
| Name | Type | Description |
|---|---|---|
| MNPId | String | Mini program ID |
| MNPIcon | String | Mini program icon |
| MNPName | String | Mini program name |
| TeamName | String | Name of the associated team |
| MNPType | String | Mini program type |
| Status | Integer | Specifies the mini program listing status. valid values: 1 (submitted), 2 (removed). |
| MNPIntro | String | Mini program introduction |
| CreateUser | String | Creator |
| CreateTime | String | Creation time |
| UpdateUser | String | Specifies the updater. |
| UpdateTime | String | Update time |
| ApplicationName | String | Application name |
| EffectStatus | Integer | Effective status of the bound application. valid values: 1 (not effective), 2 (effective). |
| EffectMNPVersionId | Integer | Specifies the ID of the application bound with the mini program. |
| EffectMNPVersion | String | Specifies the effective version number of the application bound to the mini program. |
DescribeMNPListResp
Mini program list
Used by actions: DescribeMNPList.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of entries |
| DataList | Array of DescribeMNPListData | List information |
DescribeMNPManagerDetailData
Mini program details
Used by actions: DescribeMNP.
| Name | Type | Description |
|---|---|---|
| MNPType | String | Mini program type |
| MNPId | String | Mini program ID |
| MNPName | String | Mini program name |
| MNPIcon | String | Mini program icon |
| MNPIntro | String | Mini program introduction |
| MNPDesc | String | Mini program description |
| CreateTime | String | Creation time, timestamp. |
| CreateUser | String | Creator |
| AccessStatus | Integer | Access status. 1: not connected; 2: connected. |
| TeamName | String | Name of the associated team |
| TeamId | String | Team ID |
| Status | Integer | Specifies the mini program listing status. valid values: 1 (submitted), 2 (removed). |
DescribeMNPPreviewResp
Response of querying the preview
Used by actions: DescribeMNPPreview.
| Name | Type | Description |
|---|---|---|
| MNPId | String | Mini program ID |
| MNPName | String | Mini program name |
| MNPDesc | String | Mini program description |
| MNPVersion | String | Mini program version. |
| MNPVersionIntro | String | Describes the mini program version. |
| QRCodeUrl | String | Specifies the mini program qr code. |
| PreviewEntrancePath | String | Specifies the path to the preview version. |
| QRCodeContent | String | Specifies the qr code content. |
DescribeMNPSensitiveAPIPermissionApprovalData
Details of a permission request to allow a mini program to call sensitive APIs
Used by actions: DescribeMNPSensitiveAPIPermissionApproval.
| Name | Type | Description |
|---|---|---|
| APIId | String | API ID |
| APIMethod | String | API method. |
| ApplyReason | String | Reason for application |
| RejectReason | String | Reason for rejection. |
| ApprovalStatus | Integer | Approval status. valid values: 20 (rejected), 30 (approved). |
| APIDesc | String | API feature description. |
| APIType | Integer | API type. 1: system; 2: custom. |
DescribeMNPSensitiveAPIPermissionApprovalListData
List of permission requests to allow a mini program to call sensitive APIs
Used by actions: DescribeMNPSensitiveAPIPermissionApprovalList.
| Name | Type | Description |
|---|---|---|
| ApprovalNo | String | Approval ID |
| APIId | String | Sensitive API ID |
| APIName | String | API name |
| APIMethod | String | API request method |
| MNPId | String | Mini program ID |
| MNPName | String | Mini program name |
| ApplyUser | String | Applicant |
| ApplyTime | String | Application time |
| ApplyNote | String | Application notes |
| ApprovalStatus | Integer | Approval status. 1: Processing; 20: Rejected; 30: Approved |
| ApprovalUser | String | Specifies the review user. |
| ApprovalTime | String | Approval time. |
| ApprovalNote | String | Approval notes |
| ApplicationId | String | Application ID |
| ApplicationName | String | Application name |
| ApplicationLogo | String | Specifies the application icon. |
| APIType | Integer | API type. 1: system; 2: custom. |
| APIDesc | String | API feature description. |
DescribeMNPSensitiveAPIPermissionApprovalListResp
List of permission requests to allow a mini program to call sensitive APIs
Used by actions: DescribeMNPSensitiveAPIPermissionApprovalList.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of entries |
| DataList | Array of DescribeMNPSensitiveAPIPermissionApprovalListData | List information |
DescribeMNPSensitiveAPIPermissionListData
List of sensitive APIs that can be called by a mini program
Used by actions: DescribeMNPSensitiveAPIPermissionList.
| Name | Type | Description |
|---|---|---|
| APIId | String | API ID |
| APIName | String | API name. |
| APIMethod | String | API request method |
| APIStatus | Integer | API status. |
| APIApplyStatus | Integer | API application status. |
| RejectReason | String | Reason for rejection. |
| ApprovalNo | String | Approval ID |
| ApplicationId | String | Application ID |
| ApplicationIcon | String | Specifies the application icon. |
| ApplicationName | String | Application name |
| APIType | Integer | API type. 1: system; 2: custom. |
| APIDesc | String | API feature description. |
DescribeMNPSensitiveAPIPermissionListResp
List of sensitive APIs that can be called by a mini program
Used by actions: DescribeMNPSensitiveAPIPermissionList.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of entries |
| DataList | Array of DescribeMNPSensitiveAPIPermissionListData | List data Note: This field may return null, indicating that no valid values can be obtained. |
DescribeMNPVersionResp
Result of the task to create a mini program version
Used by actions: DescribeMNPVersion.
| Name | Type | Description |
|---|---|---|
| MNPId | String | Mini program ID |
| TaskId | String | Task ID |
| TaskStatus | Integer | 1: Pending; 20: Running; 30: Failed; 60: Succeeded |
| TaskMsg | String | Task status message |
| MNPVersionId | Integer | Mini program version ID (returned when compilation succeeds) |
DescribeMPAllStageVersionsResp
List of all developer versions of a mini program
Used by actions: DescribeMNPAllStageVersions.
| Name | Type | Description |
|---|---|---|
| MNPId | String | Mini program ID. |
| MNPVersionId | Integer | Specifies the mini program version primary key id. |
| MNPName | String | Mini program name |
| MNPIcon | String | Specifies the mini program avatar. |
| MNPType | String | Mini program type |
| MNPIntro | String | Mini program introduction |
| MNPDesc | String | Mini program description |
| CreateUser | String | Specifies the developer. |
| CreateTime | String | Developer creation time. |
| MNPVersion | String | Mini program version. |
| MNPVersionIntro | String | Describes version features. |
| Phase | String | Development Platform Online. |
| ApprovalStatus | Integer | 0 pending review; 1 under review; 2 review rejection; 3 pass review; 4 review cancellation. |
| ApprovalNo | String | Approval ticket ID |
| ShowCase | Integer | Specifies whether it is a trial version. Specifies the version type. valid values: 0 (non-preview version); 1 (trial version). |
| RollbackVersion | Integer | Version number to roll back to. |
| Status | Integer | Indicates the release status. |
| VersionCurrentStatus | Integer | Specifies the current main status of the version. valid values: "0" (pending review), "1" (under review), "2" (review rejection), "3" (pass review), "4" (review cancellation). |
DescribeRevertOnlineVersionPageResp
Response of querying the rollback version list
Used by actions: DescribeMNPReleasedVersionHistory.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of entries |
| DataList | Array of QueryOnlineVersionResp | List information |
DescribeRoleListData
Role management list
Used by actions: DescribeRoleList.
| Name | Type | Description |
|---|---|---|
| RoleId | Integer | Role ID |
| RoleName | String | Role name. |
| TeamName | String | Team name |
| CreateTime | String | Creation time |
| RoleType | Integer | Role type 1-preset role 2-custom role. |
DescribeRoleListResp
Role management list
Used by actions: DescribeRoleList.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of entries |
| DataList | Array of DescribeRoleListData | List data |
DescribeTeamDetailResp
Team details
Used by actions: DescribeTeam.
| Name | Type | Description |
|---|---|---|
| TeamName | String | Team name |
| TeamRoleType | Integer | Team role type 1-mini program team 2-application team |
| AdminUserAccount | String | Administrator account |
| CreateUser | String | Creator |
| CreateTime | String | Creation time |
| MemberCount | Integer | Number of team members |
| BindMiniTeamCount | Integer | Number of bound mini program teams |
| BindTeamName | String | Name of the bound team |
| RegisterLink | String | Team registration link |
| ApplicationName | String | Application name. It Is required when querying details of a mini program team. |
| ExpireTime | Integer | Team expiration time. 0 means never expire. |
| Status | Integer | Team status. valid values: 1: normal; 2: disabled; 3: expired. |
DescribeTeamListInfoResp
Team list information
Used by actions: DescribeTeamList.
| Name | Type | Description |
|---|---|---|
| TeamId | String | Team ID |
| TeamName | String | Team name |
| AdminUserId | String | Administrator user ID |
| AdminUserAccount | String | Administrator account |
| AdminUserName | String | Administrator username |
| MemberCount | Integer | Number of team members |
| RegisterLink | String | Team registration link |
| TeamRoleTypeList | Array of Integer | Team permission type |
| RelatedTeamId | Integer | Associated team ID |
| ExpireTime | Integer | Team expiration time. 0 means never expire. |
| Status | Integer | Team status. valid values: 1: normal; 2: disabled; 3: expired. |
DescribeTeamMemberInfoResp
Team member information
Used by actions: DescribeTeamMemberList.
| Name | Type | Description |
|---|---|---|
| UserId | String | User ID |
| UserAccount | String | User account |
| UserName | String | User name |
| TeamId | String | Team ID |
| TeamName | String | Team name |
| TeamRoleName | String | Specifies the team role name. |
| TeamRoleId | Integer | Specifies the team role ID. |
| CanEdit | Boolean | Whether it is editable |
DescribeTeamMemberListPageResp
List of members
Used by actions: DescribeTeamMemberList.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of entries |
| DataList | Array of DescribeTeamMemberInfoResp | List information |
DescribeTeamPageResp
Team list
Used by actions: DescribeTeamList.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total count |
| DataList | Array of DescribeTeamListInfoResp | List information |
DescribeUserDetailResp
User details
Used by actions: DescribeUser.
| Name | Type | Description |
|---|---|---|
| UserId | String | User iD. |
| UserAccount | String | User account |
| AccountType | Integer | User account 1 - super admin 2 - platform admin 3 - ordinary member. not passing indicates all. |
| UserName | String | User name |
DescribeUserListData
User list data
Used by actions: DescribeUserList.
| Name | Type | Description |
|---|---|---|
| UserId | String | User ID |
| UserAccount | String | User account |
| AccountType | Integer | Account type. 1: super administrator; 2: platform administrator; 3: ordinary member. |
| UserName | String | User name |
| CreateTime | String | Creation time |
| Status | Integer | Status. 1: normal; 2: disabled. |
| TeamName | String | Team name |
DescribeUserListResp
User management list
Used by actions: DescribeUserList.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number of entries Note: This field may return null, indicating that no valid values can be obtained. |
| DataList | Array of DescribeUserListData | List data Note: This field may return null, indicating that no valid values can be obtained. |
DownloadApplicationConfigResp
Application configuration info
Used by actions: DescribeApplicationConfigFile.
| Name | Type | Description |
|---|---|---|
| File | String | Configuration information in Base64 format Note: This field may return null, indicating that no valid values can be obtained. |
GlobalDomainDeleteResp
Response of deleting a global domain name
Used by actions: DeleteGlobalDomain.
| Name | Type | Description |
|---|---|---|
| Result | Boolean | Result. |
GlobalDomainModifyRespResp
Response of global domain name modification
Used by actions: ModifyGlobalDomain.
| Name | Type | Description |
|---|---|---|
| Result | Integer | 0: success; 1: allowed domains exist; 2: blocked domains exist. |
MAUChartData
MAU line chart data
Used by actions: DescribeMNPMAULineChart.
| Name | Type | Description |
|---|---|---|
| DataTime | Integer | Year and month: 2024-12 |
| MAUCount | Integer | Value |
| UpdateTime | Integer | Data update time, only available when MAUCount is greater than 0. |
MAUDetail
Mini program MAU details
Used by actions: DescribeMNGMAUDataDetail, DescribeMNPMAUDataDetail.
| Name | Type | Description |
|---|---|---|
| MNPName | String | Mini program name |
| DataList | Array of MAULineChartData | MAU details |
MAUDetailData
MAU detailed data
Used by actions: DescribeMNPAdvertisingDetail.
| Name | Type | Description |
|---|---|---|
| DataTime | String | Date |
| MNPName | String | Mini program name |
| MNPType | String | Mini program type |
| EstimatedEarnings | String | Estimated revenue |
| RequestsNumber | Integer | Requests |
| Impressions | Integer | Impressions |
| ECPM | String | Effective Cost Per Mille |
| ClicksNumber | Integer | Taps |
MAUIndicatorCard
MAU metric comparison response data
Used by actions: DescribeMNGMAUMonthlyComparisonMetricCard, DescribeMNPMAUMetricCard.
| Name | Type | Description |
|---|---|---|
| ComparisonRatio | String | Growth rate (targetData - sourceData) / sourceData, returns 0 when SourceMAUNum is 0 |
| ComparisonResult | Integer | 1 Increase 2 Decrease Returns 0 when SourceMAUNum is 0 |
| SourceMAUNum | Integer | Last month's MAU data |
| TargetMAUNum | Integer | This month's MAU data |
| FlushTime | Integer | Data timestamp |
MAULineChartData
Line chart data
Used by actions: DescribeMNGMAUDataDetail, DescribeMNPMAUDataDetail.
| Name | Type | Description |
|---|---|---|
| DataTime | Integer | Year-month date data Note: This field may return null, indicating that no valid values can be obtained. |
| MAUCount | String | MAU data Note: This field may return null, indicating that no valid values can be obtained. |
MNGMAULineChartData
Mini game MAU line chart data
Used by actions: DescribeMNGMAULineChart.
| Name | Type | Description |
|---|---|---|
| DataTime | Integer | Year-month-date data Note: This field may return null, indicating that no valid values can be obtained. |
| MAUCount | Integer | MAU data Note: This field may return null, indicating that no valid values can be obtained. |
| UpdateTime | Integer | Update time |
MNGPaymentOverview
Payment overview data
Used by actions: DescribeMNGPaymentOverview, DescribeMNGPaymentReportDetail.
| Name | Type | Description |
|---|---|---|
| ARPPu | String | Paid revenue / Number of paying users * 100% |
| DataTime | String | Data time in YYYYMMDD format |
| NewPaidUseRatio | String | New paying user ratio = NewUserNum / OrderUserNum * 100% |
| NewPaidUserNum | Integer | Number of new paying users |
| NewUserPaidAmount | String | Total payment amount from new users |
| PaidAmount | String | Total payment amount |
| PaidUserNum | Integer | Number of paying users |
| RefundAmount | String | Refund amount |
| RefundNum | Integer | Number of refund orders |
| UpdateTime | Integer | Update time (timestamp in seconds) |
MNPAdOverview
Mini program advertisement overview
Used by actions: DescribeAdvertisingOverview.
| Name | Type | Description |
|---|---|---|
| EstimatedEarnings | String | Estimated revenue Note: This field may return null, indicating that no valid values can be obtained. |
| ECPM | String | Effective Cost Per Mille Note: This field may return null, indicating that no valid values can be obtained. |
| RequestsNumber | Integer | Requests Note: This field may return null, indicating that no valid values can be obtained. |
| Impressions | Integer | Impressions Note: This field may return null, indicating that no valid values can be obtained. |
| ClicksNumber | Integer | Taps Note: This field may return null, indicating that no valid values can be obtained. |
MNPAdvertisingOverview
Mini program advertising revenue
Used by actions: DescribeAdvertisingOverview.
| Name | Type | Description |
|---|---|---|
| OverviewData | MNPAdOverview | Data Note: This field may return null, indicating that no valid values can be obtained. |
MNPPaymentOverview
Payment overview data
Used by actions: DescribePaymentDataOverview.
| Name | Type | Description |
|---|---|---|
| OrderMNPNum | Integer | Number of mini programs involved in the order Note: This field may return null, indicating that no valid values can be obtained. |
| OrderNum | Integer | Total orders Note: This field may return null, indicating that no valid values can be obtained. |
| OrderPaidNum | Integer | Total paid orders Note: This field may return null, indicating that no valid values can be obtained. |
| OrderRefundNum | Integer | Total refunded orders Note: This field may return null, indicating that no valid values can be obtained. |
| OrderUnpaidNum | Integer | Total unpaid orders Note: This field may return null, indicating that no valid values can be obtained. |
| OrderUserNum | Integer | Total order users Note: This field may return null, indicating that no valid values can be obtained. |
| PaidUserNum | Integer | Total paying users Note: This field may return null, indicating that no valid values can be obtained. |
| PaidAmount | String | Amount paid Note: This field may return null, indicating that no valid values can be obtained. |
| RefundAmount | String | Total amount refunded Note: This field may return null, indicating that no valid values can be obtained. |
| TotalAmount | String | Total order amount Note: This field may return null, indicating that no valid values can be obtained. |
| UnpaidAmount | String | Unpaid amount Note: This field may return null, indicating that no valid values can be obtained. |
| UpdateTime | Integer | Timestamp Note: This field may return null, indicating that no valid values can be obtained. |
| DataTime | String | Data date Note: This field may return null, indicating that no valid values can be obtained. |
MNPTypeDefine
Mini program category information
Used by actions: DescribeMNPCategory.
| Name | Type | Required | Description |
|---|---|---|---|
| TypeName | String | No | Specifies the mini program category name. |
| TypeValue | Array of String | No | Mini program category value. |
| TypeId | Integer | No | Category ID. |
| CreateTime | Integer | No | Creation time |
| CreateUser | String | No | Creator |
| IsSystem | Boolean | No | Indicates whether it is a system category. |
Overview
Global overview data
Used by actions: DescribeGlobalOverviewDataSummary, DescribeMNGAccessAnalysisOverview, DescribeMNPAccessAnalysisOverview.
| Name | Type | Description |
|---|---|---|
| AppNum | Integer | Superapps |
| CorpNum | Integer | Teams |
| FlushTime | String | Refresh time |
| MiniAppNum | Integer | Mini programs |
| MiniGameNum | Integer | Mini games |
| MiniGameVisitNum | Integer | Mini game visits |
| UpdateNum | Integer | Mini program updates |
| VisitNum | Integer | Mini program visits |
OverviewDetail
Advertising data list fields
Used by actions: DescribeMNGAdvertisingDetail.
| Name | Type | Description |
|---|---|---|
| DataTime | String | Time |
| MNPName | String | Name |
| MNPType | String | Category |
| EstimatedEarnings | String | Estimated revenue |
| RequestsNumber | Integer | Requests |
| Impressions | Integer | Impressions |
| ECPM | String | Effective Cost Per Mille |
| ClicksNumber | Integer | Taps |
PaymentActiveRetention
Payment active retention data
Used by actions: DescribeMNGPaymentRetentionAnalysis.
| Name | Type | Description |
|---|---|---|
| OneDayRetentionUsers | Integer | Day 1 active retention of paying users |
| TwoDayRetentionUsers | Integer | Day 2 active retention of paying users |
| ThreeDayRetentionUsers | Integer | Day 3 active retention of paying users |
| FourDayRetentionUsers | Integer | Day 4 active retention of paying users |
| FiveDayRetentionUsers | Integer | Day 5 active retention of paying users |
| SixDayRetentionUsers | Integer | Day 6 active retention of paying users |
| SevenDayRetentionUsers | Integer | Day 7 active retention of paying users |
| FourteenDayRetentionUsers | Integer | Day 14 active retention of paying users |
| FifteenDayRetentionUsers | Integer | Day 15 active retention of paying users |
| ThirtyDayRetentionUsers | Integer | Day 30 active retention of paying users |
| PaymentUserNum | Integer | Number of paying users |
| DataTime | String | Data time in YYYYMMDD format |
PaymentDetail
Mini program payment detailed data
Used by actions: DescribePaymentDataDetail.
| Name | Type | Description |
|---|---|---|
| DataTime | String | Date in YYYYMMDD format |
| OrderMNPNum | Integer | Number of mini programs involved in the order |
| OrderNum | Integer | Total orders |
| OrderPaidNum | Integer | Paid orders |
| OrderRefundNum | Integer | Total refunded orders |
| OrderUnpaidNum | Integer | Unpaid orders |
| OrderUserNum | Integer | Number of users placing orders (openid) |
| PaidAmount | String | Amount paid |
| RefundAmount | String | Amount refunded |
| TotalAmount | String | Total order amount |
| UnpaidAmount | String | Unpaid amount |
| UpdateTime | Integer | Data update timestamp |
PresetResp
Encryption key returned
Used by actions: CreatePresetKey.
| Name | Type | Description |
|---|---|---|
| Key | String | RSA encryption public key. |
QueryOnlineVersionResp
Mini program online version ID
Used by actions: DescribeMNPReleasedVersionHistory.
| Name | Type | Description |
|---|---|---|
| MNPId | String | Mini program ID |
| MNPVersion | String | Version number |
| MNPVersionId | Integer | Version ID. |
| MNPVersionNote | String | Version remarks. |
| UpdateTime | String | Update time |
ReportDataResult
General response for data query reports
Used by actions: DescribeAPPDataDetailLineChart, DescribeGlobalOverviewReportDetail, DescribeMNGAccessAnalysisLineChart, DescribeMNGActiveUserRealTimeStatistics, DescribeMNGPaymentLineChart, DescribeMNPActiveUserRealTimeStatistics, DescribeMNPReportDataLineChart, DescribePaymentDataLineChart.
| Name | Type | Description |
|---|---|---|
| DataResult | String | Base64-encoded result data |
| ExecSql | String | Executed SQL Note: This field may return null, indicating that no valid values can be obtained. |
| ExecTime | Integer | Execution time Note: This field may return null, indicating that no valid values can be obtained. |
| IndexId | String | Query index ID Note: This field may return null, indicating that no valid values can be obtained. |
ResourceIdInfo
Unified operation success ID - integer
Used by actions: ModifyMNP.
| Name | Type | Description |
|---|---|---|
| ResourceId | Integer | Specifies the resource ID returned by the business. 0: no trial version available. A trial version is currently available and uploaded by the current user. 2: a trial version is currently available and uploaded by another user. |
ResourceIdStringInfo
The general parameter for resource ID returned for successful operations
Used by actions: CreateApplication, CreateMNP, CreateMNPSensitiveAPIPermissionApproval, CreateUser.
| Name | Type | Description |
|---|---|---|
| ResourceId | String | The ID of the resource returned Note: This field may return null, indicating that no valid values can be obtained. |
RetentionData
Retention data
Used by actions: DescribeMNGRetentionData, DescribeMNPRetentionData.
| Name | Type | Description |
|---|---|---|
| ActiveUserCount | Integer | Number of active users |
| OneDayRetentionUsers | Integer | Day 1 retention of active users |
| TwoDayRetentionUsers | Integer | Day 2 retention of active users |
| ThreeDayRetentionUsers | Integer | Day 3 retention of active users |
| FourDayRetentionUsers | Integer | Day 4 retention of active users |
| FiveDayRetentionUsers | Integer | Day 5 retention of active users |
| SixDayRetentionUsers | Integer | Day 6 retention of active users |
| SevenDayRetentionUsers | Integer | Day 7 retention of active users |
| FourteenDayRetentionUsers | Integer | Day 14 retention of active users |
| ThirtyDayRetentionUsers | Integer | Day 30 retention of active users |
| NewUserCount | Integer | Number of new users |
| OneDayRetentionNewUsers | Integer | Day 1 retention of new users |
| TwoDayRetentionNewUsers | Integer | Day 2 retention of new users |
| ThreeDayRetentionNewUsers | Integer | Day 3 retention of new users |
| FourDayRetentionNewUsers | Integer | Day 4 retention of new users |
| FiveDayRetentionNewUsers | Integer | Day 5 retention of new users |
| SixDayRetentionNewUsers | Integer | Day 6 retention of new users |
| SevenDayRetentionNewUsers | Integer | Day 7 retention of new users |
| FourteenDayRetentionNewUsers | Integer | Day 14 retention of new users |
| ThirtyDayRetentionNewUsers | Integer | Day 30 retention of new users |
| DataTime | String | Data time in YYYYMMDD format |
StringData
String object
Used by actions: DescribeMNPOfflinePackageURL.
| Name | Type | Required | Description |
|---|---|---|---|
| Data | String | No | string type response data. |
UploadFileTempSecret
Temporary key for file upload
Used by actions: DescribeTempSecret4UploadFile2Cos.
| Name | Type | Description |
|---|---|---|
| Bucket | String | Bucket Note: This field may return null, indicating that no valid values can be obtained. |
| Region | String | Region Note: This field may return null, indicating that no valid values can be obtained. |
| Path | String | Destination of upload Note: This field may return null, indicating that no valid values can be obtained. |
| TempSecretId | String | Temporary secret ID Note: This field may return null, indicating that no valid values can be obtained. |
| TempSecretKey | String | Temporary secret key Note: This field may return null, indicating that no valid values can be obtained. |
| Token | String | Token Note: This field may return null, indicating that no valid values can be obtained. |
| AccelerateEnable | Integer | Whether to enable global acceleration. Valid values: 0 (no), 1 (yes) |
VisitData
Page visit data
Used by actions: DescribeMNPPageAnalysisDetail.
| Name | Type | Description |
|---|---|---|
| VisitCount | Integer | Number of visits |
| AvgDeviceVisitDeep | String | Average pages per device - visit_page_count / active_device_num |
| AvgCountVisitDeep | String | Pages per visit - visit_page_count / miniapp_open_num |
| AvgPageVisitDuration | String | Average visit duration - miniapp_total_duration / visit_page_count |
| AvgCountVisitDuration | String | Average visit duration per session miniapp_total_duration/miniapp_open_num |
| DataTime | Integer | Refresh time in YYYYMMDD format |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback