有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: ses.tencentcloudapi.com 。

获取近期发送的统计情况,包含发送量、送达率、打开率、退信率等一系列数据。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetStatisticsReport。
Version String 公共参数,本接口取值:2020-10-02。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-guangzhou, ap-hongkong 。
StartDate Date 开始日期
示例值:2020-10-01
EndDate Date 结束日期
示例值:2020-10-03
Domain String 发信域名
示例值:qcloud.com
ReceivingMailboxType String 收件方邮箱类型,例如gmail.com
示例值:gmail.com

3. 输出参数

参数名称 类型 描述
DailyVolumes Array of Volume 发信统计报告,按天
OverallVolume Volume 发信统计报告,总览
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取统计数据

输入示例

POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetStatisticsReport
<公共请求参数>

{
    "Domain": "qcloud.com",
    "StartDate": "2020-10-01",
    "EndDate": "2020-10-03",
    "ReceivingMailboxType": "gmail.com"
}

输出示例

{
    "Response": {
        "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72",
        "DailyVolumes": [
            {
                "SendDate": "2020-10-01",
                "RequestCount": 1000,
                "AcceptedCount": 999,
                "DeliveredCount": 998,
                "OpenedCount": 300,
                "ClickedCount": 199,
                "BounceCount": 5,
                "UnsubscribeCount": 1
            }
        ],
        "OverallVolume": {
            "SendDate": "2020-10-01",
            "RequestCount": 1000,
            "AcceptedCount": 999,
            "DeliveredCount": 998,
            "OpenedCount": 300,
            "ClickedCount": 199,
            "BounceCount": 5,
            "UnsubscribeCount": 1
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.WrongDate 搜索日期错误,请检查日期及格式是否有效。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。