All Products
Search
Document Center

Edge Security Acceleration:DescribeSiteTopData

Last Updated:Nov 07, 2025

Queries the top-ranking records in a traffic analytics report by website or Alibaba Cloud account.

Operation description

  • If you do not specify the StartTime or EndTime parameter, the request returns the data collected in the previous 24 hours. If you specify both parameters, the request returns the data collected within the specified time range.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
esa:DescribeSiteTopDatanone
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SiteIdintegerNo

The website ID, which can be obtained by calling the ListSites operation.

If you do not specify this parameter, the system returns data by account.

1150376036*****
StartTimestringNo

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.

2023-04-08T16:00:00Z
EndTimestringNo

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

Note The end time must be later than the start time.
2023-04-09T16:00:00Z
IntervalstringNo

The time interval between the data entries to return. Unit: seconds.

300
Fieldsarray<object>Yes

The metrics to query.

objectYes

The metric to query.

FieldNamestringNo

The metric name.

Traffic
DimensionarrayNo

The dimensions at which you want to query data.

stringNo

The dimension at which you want to query data.

Note For more information, see the corresponding log fields.
ClientZoneCode
LimitstringNo

The number of top-ranking data entries to query.

Enumeration Value:
  • 5: 5.
  • 10: 10.
  • 150: 150.
5

Response parameters

ParameterTypeDescriptionExample
object
Dataarray<object>

The returned data.

contentobject

The returned data.

FieldNamestring

The metric name.

Traffic
DimensionNamestring

The dimension at which data was queried.

ALL
DetailDataarray<object>

The returned data.

detailDataobject

The returned data.

DimensionValuestring

The dimension value.

ALL
Valueany

The queried numeric value.

123
RequestIdstring

The request ID.

35C66C7B-671H-4297-9187-2C447724****
StartTimestring

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.

2023-04-08T16:00:00Z
EndTimestring

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.

2023-04-09T16:00:00Z
SamplingRatefloat

The sampling rate.

100

Examples

Sample success responses

JSONformat

{
  "Data": [
    {
      "FieldName": "Traffic",
      "DimensionName": "ALL",
      "DetailData": [
        {
          "DimensionValue": "ALL",
          "Value": 123
        }
      ]
    }
  ],
  "RequestId": "35C66C7B-671H-4297-9187-2C447724****",
  "StartTime": "2023-04-08T16:00:00Z",
  "EndTime": "2023-04-09T16:00:00Z",
  "SamplingRate": 100
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.TimeRangeThe specified time range exceeds the limit. Adjust it and try again.The specified time range exceeds the limit. Adjust it and try again.
400TooManyRequestsToo many requests.Please try again later.Requests are too frequent, please try again later.
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.The end time you entered is earlier than the start time. Please check and try again.
400InvalidParameterParameter verification failed. Check your configurations and try again.Parameter verification failed. Check your configurations and try again.
400QuotaCheckFailed.FunctionThe feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.The feature is unavailable in your plan. Upgrade the plan or contact your account manager to request the feature.
400InvalidParameter.FieldThe specified Field is invalid.The specified Field is invalid. For more information, see OpenAPI Documentation .
400InvalidParameter.DimensionThe specified Dimension is invalid.The specified Dimension is invalid. For more information, see OpenAPI Documentation .
400InvalidTime.MalformedSpecified start time or end time is malformed.The specified time format is incorrect. The time must conform to the yyyy-MM-ddTHH:mm:ssZ format. Please enter it correctly and try again.
400TooManyDimensionsToo many query dimensions specified. Delete some and try again.Too many query dimensions specified. Delete some and try again.

For a list of error codes, visit the Service error codes.