DescribeStreamPackageSSAIUsage

Last updated: 2025-10-31 17:50:31

DescribeStreamPackageSSAIUsage

Last updated: 2025-10-31 17:50:31

1. API Description

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

This API is used to query SSAI ad replacement usage.

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: DescribeStreamPackageSSAIUsage.
Version	Yes	String	Common Params. The value used for this API: 2020-05-27.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
StartTime	No	String	Start time.
EndTime	No	String	End time.
ChannelIds.N	No	Array of String	Specifies the channel id you want to query.
Types.N	No	Array of String	Specifies the ad type you want to query. valid values: Preroll/Midroll. if empty, query all types by default.

3. Output Parameters

Parameter Name	Type	Description
Info	SSAIUsageInfo	SSAI usage information.
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 Calling the API

This example shows you how to query the SSAI amount.

Input Example

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

{
    "StartTime": "2025-05-01T00:00:00+08:00",
    "EndTime": "2025-05-01T10:00:00+08:00"
}

Output Example

{
    "Response": {
        "Info": {
            "AdRequestSuccess": 1,
            "AdRequestFail": 0,
            "Impression": 0,
            "AdMarkerTime": 0,
            "ReplacedTime": 0,
            "MidFillRate": 0,
            "PreReqNum": 1,
            "PreReplacedNum": 0,
            "PreReplaceRate": 0,
            "UsageDetails": [
                {
                    "UniqId": "018f141593c91ea540e603706c52",
                    "ChannelId": "66503E8E0000930000F9",
                    "ChannelName": "ssai_channel",
                    "AdType": "Preroll",
                    "AdRequestSuccess": 1,
                    "AdRequestFail": 0,
                    "Impression": 0,
                    "Start": 0,
                    "FirstQuarter": 0,
                    "Midpoint": 0,
                    "ThirdQuarter": 0,
                    "Complete": 0,
                    "AdMarkerTime": 0,
                    "ReplacedTime": 0,
                    "MidFillRate": 0,
                    "PreReqNum": 1,
                    "PreReplacedNum": 0,
                    "PreReplaceRate": 0
                }
            ]
        },
        "RequestId": "req-xxx123"
    }
}

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
InternalError	Internal error.
InternalError.GetSSAIChannelsFailed	Failed to obtain SSAI ad configuration.
InternalError.GetSSAIUsagePartialFailed	Failed to obtain SSAI ad configuration usage.
InvalidParameter.InvalidParameterChannelId	SSAI channel id is invalid.
InvalidParameter.Type	VOD remux task type error.

Was this page helpful?

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

Yes

Feedback

tencent cloud