Queries and sorts frequently requested web pages on a specified day for a specified accelerated domain name. You can query data that is collected within the last 90 days.

Before you call this operation, take note of the following considerations:
  • If you do not set the StartTime parameter, the data on the previous day is queried.
  • You can specify only one domain name.

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 DescribeDcdnDomainTopReferVisit

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

DomainName String Yes example.com

The accelerated domain name. You can specify only one domain name.

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

The start 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.

To query the data on a specified day, use the yyyy-MM-ddT16:00:00Z format.

If you do not specify this parameter, data collected within the last 24 hours is queried by default.

SortBy String No pv

The method that is used to sort the web pages. Valid values:

  • traf: by network traffic.
  • pv: by the number of visits.

Default value: pv.

Response parameters

Parameter Type Example Description
DomainName String example.com

The accelerated domain name.

RequestId String 95994621-8382-464B-8762-C708E73568D1

The ID of the request.

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

The start of the time range during which the data is collected.

TopReferList Array of ReferList

The list of frequently referenced URLs returned.

ReferList
Flow String 460486880

The network traffic. Unit: bytes.

FlowProportion Float 0.35

The proportion of the network traffic.

ReferDetail String 123.57.158.x

The complete referenced URL.

VisitData String 229567

The number of visits to the URL.

VisitProportion Float 0.35

The proportion of the visits.

Examples

Sample requests

http://dcdn.aliyuncs.com/?Action=DescribeDcdnDomainTopReferVisit
&DomainName=example.com
&StartTime=2018-10-03T16:00:00Z
&<Common request parameters>

Sample success responses

XML format

<DescribeDcdnDomainTopReferVisitResponse>
	  <TopReferList>
		    <ReferList>
			      <VisitData>229567</VisitData>
			      <ReferDetail>-</ReferDetail>
			      <VisitProportion>0.35</VisitProportion>
			      <Flow>460486880</Flow>
			      <FlowProportion>0.35</FlowProportion>
		    </ReferList>
		    <ReferList>
			      <VisitData>2496</VisitData>
			      <ReferDetail>123.57.158.x</ReferDetail>
			      <VisitProportion>0.35</VisitProportion>
			      <Flow>460486880</Flow>
			      <FlowProportion>0.35</FlowProportion>
		    </ReferList>
		    <ReferList>
			      <VisitData>448</VisitData>
			      <ReferDetail>live-hunantv.cdnpe.com</ReferDetail>
			      <VisitProportion>0.35</VisitProportion>
			      <Flow>460486880</Flow>
			      <FlowProportion>0.35</FlowProportion>
		    </ReferList>
		    <ReferList>
			      <VisitData>3</VisitData>
			      <ReferDetail>video.ccdemo.ccgslb.net</ReferDetail>
			      <VisitProportion>0.35</VisitProportion>
			      <Flow>460486880</Flow>
			      <FlowProportion>0.35</FlowProportion>
		    </ReferList>
	  </TopReferList>
	  <RequestId>95994621-8382-464B-8762-C708E73568D1</RequestId>
	  <DomainName>example.com</DomainName>
	  <StartTime>2018-10-03T16:00:00Z</StartTime>
</DescribeDcdnDomainTopReferVisitResponse>

JSON format

{
    "TopReferList": {
        "ReferList": [
            {
                "VisitData": "229567",
                "ReferDetail": "-",
                "VisitProportion": 0.35,
                "Flow": "460486880",
                "FlowProportion": 0.35
            },
            {
                "VisitData": "2496",
                "ReferDetail": "123.57.158.8",
                "VisitProportion": 0.35,
                "Flow": "460486880",
                "FlowProportion": 0.35
            },
            {
                "VisitData": "448",
                "ReferDetail": "live-hunantv.cdnpe.com",
                "VisitProportion": 0.35,
                "Flow": "460486880",
                "FlowProportion": 0.35
            },
            {
                "VisitData": "3",
                "ReferDetail": "video.ccdemo.ccgslb.net",
                "VisitProportion": 0.35,
                "Flow": "460486880",
                "FlowProportion": 0.35
            }
        ]
    },
    "RequestId": "95994621-8382-464B-8762-C708E73568D1",
    "DomainName": "example.com",
    "StartTime": "2018-10-03T16:00:00Z"
}

Error codes

HttpCode Error code Error message Description
400 InvalidStartTime.Malformed The specified StartTime parameter is invalid. The error message returned because the format of the specified start time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400 InvalidStartTime.ValueNotSupported The specified StartTime is invalid. The error message returned because the specified start time is not supported. Specify another value.

For a list of error codes, visit the API Error Center.