ExportScreenPage

Download PDF

Last updated: 2025-11-13 21:02:45

ExportScreenPage

Last updated: 2025-11-13 21:02:45

Download PDF

1. API Description

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

This API is used to export a screenshot.

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: ExportScreenPage.
Version	Yes	String	Common Params. The value used for this API: 2022-01-05.
Region	No	String	Common Params. This parameter is not required.
ProjectId	Yes	String	Project ID.
PageId	Yes	String	Page ID.
CanvasType	No	String	Canvas type. Grid canvas: GRID; Free canvas: FREE.
PicType	No	String	Image export type. Valid values: Base64, and URL (valid period: 1 day).
WidgetIds.N	No	Array of String	Component IDs. When empty, export the entire page.
AsyncRequest	No	Boolean	Whether it is an async request.
TranId	No	String	Transaction ID.

3. Output Parameters

Parameter Name	Type	Description
ErrorInfo	ErrorInfo	Custom error information object. Note: This field may return null, indicating that no valid values can be obtained.
Extra	String	Extension parameter. Note: This field may return null, indicating that no valid values can be obtained.
Data	PageScreenListVO	Returned data results. Note: This field may return null, indicating that no valid values can be obtained.
Msg	String	Response message. 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 Exporting a Free Canvas

This example shows you how to export a free canvas.

Input Example

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

{
    "ProjectId": "1907",
    "PageId": "39618",
    "CanvasType": "FREE",
    "PicType": "url",
    "WidgetIds": []
}

Output Example

{
    "Response": {
        "ErrorInfo": {
            "ErrorTip": "",
            "ErrorMessage": "API error",
            "ErrorLevel": "ERROR",
            "DocLink": "",
            "FAQ": "",
            "ReservedField": ""
        },
        "Extra": "",
        "Data": {
            "PicType": "PNG",
            "List": [
                {
                    "Content": "",
                    "WidgetId": "saia192"
                }
            ],
            "TranId": "qwq211221",
            "TranStatus": 0
        },
        "Msg": "Failed",
        "RequestId": "ddsds122321-fdsd12"
    }
}

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
AuthFailure	CAM signature/authentication error.
DryRunOperation	DryRun operation means the request will be successful, but the DryRun parameter is passed.
FailedOperation	Operation failed.
InternalError	Internal error.
InternalError.Internal	Internal error.
InvalidParameter	Parameter error.
InvalidParameterValue	Parameter value error.
MissingParameter	Parameters are missing.
MissingParameter.MissingParam	The required parameter is missing.
UnsupportedOperation.BIError	Default business exception.

Was this page helpful?

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

Yes

Feedback

tencent cloud