All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveDomainPvUvData

更新時間:Jun 05, 2024

Queries the data of page views (PVs) and unique visitors (UVs) of a streaming domain.

Usage notes

  • You can call this operation to query the geographical distribution of viewers, the visitor ranking of a streaming domain, and the number of independent requests from IP addresses under a streaming name within a specified time period.
  • If you do not specify the StartTime or EndTime parameter, the data of the last 24 hours is queried. You can specify both the StartTime and EndTime parameters to query the data of a specified time range.
  • You can specify only one streaming domain in each request.
  • You can query data in the last 90 days.

QPS limit

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action String Yes DescribeLiveDomainPvUvData

The operation that you want to perform. Set the value to DescribeLiveDomainPvUvData.

DomainName String Yes example.com

The streaming domain.

StartTime String No 2018-03-17T16:00:00Z

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

EndTime String No 2018-03-20T16:00:00Z

The end of the time range to query. The end time must be later than the start time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

Response parameters

Parameter

Type

Example

Description

EndTime String 2018-03-20T16:00:00Z

The end of the time range during which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

StartTime String 2018-03-17T16:00:00Z

The beginning of the time range during which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

RequestId String E9D3257A-1B7C-414C-90C1-8D07AC47BCAC

The request ID.

DomainName String example.com

The streaming domain.

DataInterval String 3600

The time interval between the entries returned. Unit: seconds. Default value: 3600.

PvUvDataInfos Array of PvUvDataInfo

The data of PVs and UVs.

PvUvDataInfo
PV String 3036

The data of PVs.

TimeStamp String 2018-03-19T16:00:00Z

The timestamp of the returned data. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

UV String 2

The data of UVs.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainPvUvData
&DomainName=example.com
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeLiveDomainPvUvDataResponse>
<EndTime>2018-03-20T16:00:00Z</EndTime>
<RequestId>E9D3257A-1B7C-414C-90C1-8D07AC47BCAC</RequestId>
<DomainName>example.com</DomainName>
<DataInterval>3600</DataInterval>
<StartTime>2018-03-17T16:00:00Z</StartTime>
<PvUvDataInfos>
    <PvUvDataInfo>
        <UV>2</UV>
        <PV>3036</PV>
        <TimeStamp>2018-03-19T16:00:00Z</TimeStamp>
    </PvUvDataInfo>
</PvUvDataInfos>
</DescribeLiveDomainPvUvDataResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "DescribeLiveDomainPvUvDataResponse" : {
    "EndTime" : "2018-03-20T16:00:00Z",
    "RequestId" : "E9D3257A-1B7C-414C-90C1-8D07AC47BCAC",
    "DomainName" : "example.com",
    "DataInterval" : 3600,
    "StartTime" : "2018-03-17T16:00:00Z",
    "PvUvDataInfos" : {
      "PvUvDataInfo" : {
        "UV" : 2,
        "PV" : 3036,
        "TimeStamp" : "2018-03-19T16:00:00Z"
      }
    }
  }
}

Error codes

HttpCode

Error code

Error message

Description

400 InvalidStartTime.Malformed Specified StartTime is malformed. The format of the start time is invalid. Check whether the value of the StartTime parameter is valid.
400 InvalidEndTime.Malformed Specified EndTime is malformed. The format of the end time is invalid. Check whether the value of the EndTime parameter is valid.
400 InvalidStartTime.ValueNotSupported The specified value of parameter StartTime is not supported. The value specified for the StartTime parameter is invalid.
400 InvalidTime.ValueNotSupported Specified Time is malformed. The start time and end time do not match.

For a list of error codes, see Service error codes.

Special error codes

Error code

Error message

HTTP status code

Description

Throttling

Request was denied due to request throttling.

503

The error message returned because the request was denied due to throttling.

InvalidDomain.NotFound

The domain provided does not belong to you.

404

The error message returned because the specified domain name does not exist or does not belong to the current account.

InvalidTime.ValueNotSupported

Specified Time is malformed.

400

The error message returned because the time range specified by the EndTime and StartTime parameters exceeds 90 days or the value of the EndTime parameter or the StartTime parameter is invalid.