DescribePaymentDataLineChart

Last updated:2026-01-16 14:49:49

DescribePaymentDataLineChart

Last updated: 2026-01-16 14:49:49

1. API Description

Domain name for API request: tcsas.intl.tencentcloudapi.com.

This API is used to retrieve the line chart data related to standard payment for a mini program within a specified date range.

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: DescribePaymentDataLineChart.
Version	Yes	String	Common Params. The value used for this API: 2025-01-06.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
PlatformId	Yes	String	Tenant ID
ReportId	Yes	String	Fixed value: payment_data_analysis
IndexId	Yes	String	IndexId (optional): order_user_num: Number of users placing orders order_num: Total orders total_amount: Total amount order_unpaid_num: Total unpaid orders unpaid_amount: Unpaid amount order_paid_num: Total paid orders paid_amount: Amount paid order_refund_num: Total refunded orders refund_amount: Total amount refunded
QueryData	Yes	String	Input parameter base64 string: {"Platform":0,"MnpIds":["mp9e7qluz4i3z3km"],"BeginDate":20251031,"EndDate":20251129,"DataType":"1","PaymentType":1}

3. Output Parameters

Parameter Name	Type	Description
Data	Array of ReportDataResult	Data display Note: This field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 demo

Input Example

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

{
    "PlatformId": "T04398WY9481762VZTT",
    "ReportId": "payment_data_analysis",
    "IndexId": "order_unpaid_num",
    "QueryData": "eyJQbGF0Zm9ybSI6MCwiTW5wSWRzIjpbIm1wMXZkODFudGJpdGo5azIiXSwiQmVnaW5EYXRlIjoyMDI1MTEyNCwiRW5kRGF0ZSI6MjAyNTExMzAsIkRhdGFUeXBlIjoiMSIsIlBheW1lbnRUeXBlIjoxfQ=="
}

Output Example

{
    "Response": {
        "Data": [
            {
                "DataResult": "W1siMjAyNTExMjQiLCIwIl0sWyIyMDI1MTEyNSIsIjAiXSxbIjIwMjUxMTI2IiwiMCJdLFsiMjAyNTExMjciLCIwIl0sWyIyMDI1MTEyOCIsIjMiXSxbIjIwMjUxMTI5IiwiMCJdLFsiMjAyNTExMzAiLCIwIl1d",
                "ExecSql": "",
                "ExecTime": 0,
                "IndexId": "order_unpaid_num"
            }
        ],
        "RequestId": "ca5464dd-b288-4454-9e62-2dfccf30647b"
    }
}

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

Tencent Cloud CLI 3.0

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
FailedOperation.NoAccessPermission	FailedOperation.NoAccessPermission
FailedOperation.PackageAlreadyExpired	FailedOperation.PackageAlreadyExpired
InvalidParameter	Incorrect parameter.
InvalidParameterValue	Invalid parameter value.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud