tencent cloud

All product documents
Real-time Teleoperation
DocumentationReal-time TeleoperationAPI DocumentationSession APIsDescribeSessionStatisticsByInterval
DescribeSessionStatisticsByInterval
Download PDF
Last updated: 2025-09-18 23:36:20
DescribeSessionStatisticsByInterval
Last updated: 2025-09-18 23:36:20
Download PDF

1. API Description

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

Getting session statistics for each time period

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: DescribeSessionStatisticsByInterval.
Version Yes String Common Params. The value used for this API: 2022-03-25.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ProjectId Yes String Project id.
StatisticInterval Yes String Statistical time interval: hour|day|month.
DeviceId No String Device id.
StartTime No Integer Start time in seconds.
EndTime No Integer End time in seconds.

3. Output Parameters

Parameter Name Type Description
SessionStatistics Array of SessionIntervalStatistic Session statistics for each time period.
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 Example

Input Example

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

{
    "ProjectId": "abcdefg",
    "EndTime": "1670000000",
    "StatisticInterval": "hour",
    "DeviceId": "dev2",
    "StartTime": "0"
}

Output Example

{
    "Response": {
        "RequestId": "abcdefg-774e-4756-9f5b-8faa55ae1e5b",
        "SessionStatistics": [
            {
                "ActiveFieldDeviceNum": 1,
                "ActiveRemoteDeviceNum": 0,
                "SessionNum": 1,
                "StartTime": 1661151600,
                "EndTime": 1661152600,
                "TotalDuration": 20,
                "NotBadSessionRatio": 50
            },
            {
                "ActiveFieldDeviceNum": 1,
                "ActiveRemoteDeviceNum": 0,
                "SessionNum": 2,
                "StartTime": 1661162400,
                "EndTime": 1661152600,
                "TotalDuration": 20,
                "NotBadSessionRatio": 10
            },
            {
                "ActiveFieldDeviceNum": 1,
                "ActiveRemoteDeviceNum": 1,
                "SessionNum": 4,
                "StartTime": 1661166000,
                "EndTime": 1661176000,
                "TotalDuration": 604,
                "NotBadSessionRatio": 20
            },
            {
                "ActiveFieldDeviceNum": 1,
                "ActiveRemoteDeviceNum": 0,
                "SessionNum": 1,
                "StartTime": 1661166000,
                "EndTime": 1661176000,
                "TotalDuration": 10,
                "NotBadSessionRatio": 30
            }
        ]
    }
}

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
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
MissingParameter Missing required parameters.
OperationDenied Operation denied.
ResourceNotFound The resource does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Chat
Hi, I can answer your questions or connect you with a consultant.
Online Support
Connect you with a consultant or answer your questions.
Contact
Contact Us
Contact our sales team or business advisors to help your business.
24/7 Technical Support
Open a ticket if you're looking for further assistance
24/7 Phone Support
Toll Free
Hong Kong, China
+852 800 906 020
United States
+1 844 606 0804
United Kingdom
+44 808 196 4551
Canada
+1 888 605 7930
Australia
+61 1300 986 386
EdgeOne hotlinePaid
+852 300 80699
More local hotlines coming soon