接口请求域名： tcsas.intl.tencentcloudapi.com 。
小程序留存数据
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeMNPRetentionData。 |
| Version | 是 | String | 公共参数，本接口取值：2025-01-06。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| TimeBegin | 是 | Integer | 起始时间 |
| MNPId | 是 | String | 小程序id |
| PlatformId | 是 | String | 租户id |
| DataType | 是 | Integer | 类型：1生产，0非生产 |
| TimeEnd | 是 | Integer | 结束时间 |
| Platform | 是 | Integer | 0 查询全部,2-android,3-iOS |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of RetentionData | 数据展示 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: tcsas.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMNPRetentionData
<公共请求参数>
{
"TimeBegin": 20251204,
"MNPId": "mp1vd81ntbitj9k2",
"PlatformId": "T04398WY9481762VZTT",
"DataType": 1,
"TimeEnd": 20251204,
"Platform": 0
}
{
"Response": {
"Data": [
{
"ActiveUserCount": 0,
"DataTime": "2025-12-04",
"FiveDayRetentionNewUsers": 0,
"FiveDayRetentionUsers": 0,
"FourDayRetentionNewUsers": 0,
"FourDayRetentionUsers": 0,
"FourteenDayRetentionNewUsers": 0,
"FourteenDayRetentionUsers": 0,
"NewUserCount": 24,
"OneDayRetentionNewUsers": 0,
"OneDayRetentionUsers": 0,
"SevenDayRetentionNewUsers": 0,
"SevenDayRetentionUsers": 0,
"SixDayRetentionNewUsers": 0,
"SixDayRetentionUsers": 0,
"ThirtyDayRetentionNewUsers": 0,
"ThirtyDayRetentionUsers": 0,
"ThreeDayRetentionNewUsers": 0,
"ThreeDayRetentionUsers": 0,
"TwoDayRetentionNewUsers": 0,
"TwoDayRetentionUsers": 0
}
],
"RequestId": "3f1dd0b0-4152-4568-aec0-e7dac58a3b8d"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.NoAccessPermission | FailedOperation.NoAccessPermission |
| FailedOperation.RecordNotFound | FailedOperation.RecordNotFound |
| FailedOperation.UserNotFound | FailedOperation.UserNotFound |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter.LoginInfoNotFound | MissingParameter.LoginInfoNotFound |
文档反馈