tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

GetStatisticsReport

Last updated: 2023-06-12 16:22:41

1. API Description

Domain name for API request: ses.tencentcloudapi.com.

This API is used to get the email sending statistics over a recent period, including data on sent emails, delivery success rate, open rate, bounce rate, and so on.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: GetStatisticsReport.
Version Yes String Common Params. The value used for this API: 2020-10-02.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
StartDate Yes Date Start date.
EndDate Yes Date End date.
Domain No String Sender domain.
ReceivingMailboxType No String Recipient address type, for example, gmail.com.

3. Output Parameters

Parameter Name Type Description
DailyVolumes Array of Volume Daily email sending statistics.
OverallVolume Volume Overall email sending statistics.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting statistics

Input Example

POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetStatisticsReport
<Common request parameters>

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

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.WrongDate Incorrect search date. Make sure the date and its format are valid.
OperationDenied Operation denied.
RequestLimitExceeded The number of requests exceeds the frequency limit.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy