All Products
Search
Document Center

DescribeDomainTopUrlVisit

Last Updated: Nov 13, 2018

Description

You can call this operation to obtain the list of frequently visited URLs on a specified day for a domain name.

If you do not specify the StartTime parameter, you obtain the data for the previous day by default.

Note

  • You can specify only one domain name.
  • You can only obtain the data for the last 90 days.

Request parameters

Name Type Required Description
Action String Yes The operation that you want to perform.
Set the value to DescribeDomainTopUrlVisit.
DomainName String Yes The domain name. You can specify only one domain name.
StartTime String No The start time of the queried data.
The format is YYYY-MM-DDThh:mm:ssZ. When you query the data for a specified day, the YYYY-MM-DDT16:00:00Z format is recommended.
If you do not specify this parameter, you obtain the data for the last 24 hours by default.
SortBy String No The ranking method. You can rank the data by traffic or page view. The data is ranked by page view by default.

Response parameters

Name Type Description
RequestId String The ID of the request.
DomainName String The specified domain name.
StartTime String The start time of the queried data.
AllUrlList UrlList[] The list of frequently visited URLs.
Url200List UrlList[] The list of URLs with an HTTP status code of 2xx.
Url300List UrlList[] The list of URLs with an HTTP status code of 3xx.
Url400List UrlList[] The list of URLs with an HTTP status code of 4xx.
Url500List UrlList[] The list of URLs with an HTTP status code of 5xx.

UrlList

Name Type Description
UrlDetail String The complete URL.
VisitData String The number of visits.
VisitProportion Float The proportion of visits.
Flow String The traffic. Unit: byte.
FlowProportion Float The proportion of the traffic.

Examples

Sample requests

  1. http://cdn.aliyuncs.com?Action=DescribeDomainTopUrlVisit&DomainName=example.com
  2. &StartTime=2018-10-03T16:00:00Z
  3. &<Common request parameters>

Sample responses

JSON format

  1. {
  2. "AllUrlList": {
  3. "UrlList": [
  4. {
  5. "VisitData": "161673",
  6. "UrlDetail": "http://example1.com/nn_live/nn_x64/a0.m3u8",
  7. "VisitProportion": 0.35,
  8. "Flow": "460486880",
  9. "FlowProportion": 0.35
  10. },
  11. {
  12. "VisitData": "37",
  13. "UrlDetail": "http://example2.com/nn_live/nn_x64/ZXg9MQ,,/HNJSMPP360.ts",
  14. "VisitProportion": 0.35,
  15. "Flow": "460486880",
  16. "FlowProportion": 0.35
  17. }
  18. ]
  19. },
  20. "Url300List": {
  21. "UrlList": [
  22. {
  23. "VisitData": "161673",
  24. "UrlDetail": "http://example3.com/nn_live/nn_x64/aWQ9SE5KU0GNfbGl2ZQ,,/HNJSMPP360.m3u8",
  25. "VisitProportion": 0.35,
  26. "Flow": "460486880",
  27. "FlowProportion": 0.35
  28. },
  29. {
  30. "VisitData": "3",
  31. "UrlDetail": "http://example4.com/nn_live/nn_x64/aWQ9SE5KU01QUDZXg9MQ,,/HNJSMPP360.ts",
  32. "VisitProportion": 0.35,
  33. "Flow": "460486880",
  34. "FlowProportion": 0.35
  35. }
  36. ]
  37. },
  38. "Url400List": {
  39. "UrlList": [
  40. {
  41. "VisitData": "1884",
  42. "UrlDetail": "http://example5.com/nn_live/nn_x64/aWQ9SE5KU01QUhbGxfcGNfbGl2ZQ,,/HNJSMPP360.m3u8",
  43. "VisitProportion": 0.35,
  44. "Flow": "460486880",
  45. "FlowProportion": 0.35
  46. },
  47. {
  48. "VisitData": "1",
  49. "UrlDetail": "http://example6.com/nn_live/nn_x64/aWQ9SEEwODgmpbmRleZPTE,/HNJSMPP360.ts",
  50. "VisitProportion": 0.35,
  51. "Flow": "460486880",
  52. "FlowProportion": 0.35
  53. }
  54. ]
  55. },
  56. "RequestId": "64D28B53-5902-409B-94F6-FD46680144FE",
  57. "DomainName": "example.com",
  58. "Url200List": {
  59. "UrlList": [
  60. {
  61. "VisitData": "161673",
  62. "UrlDetail": "http://example7.com/nn_live/nn_x64/aWQ9SE5KU0bGxfcGNfbGl2ZQ,,/HNJSMPP360.m3u8",
  63. "VisitProportion": 0.35,
  64. "Flow": "460486880",
  65. "FlowProportion": 0.35
  66. },
  67. {
  68. "VisitData": "3",
  69. "UrlDetail": "http://example8.com/nn_live/nn_x64/aWQ9SE5KU01QUDMlPTIwMTxMDk5ZXg9MQ,,/HNJSMPP360.ts",
  70. "VisitProportion": 0.35,
  71. "Flow": "460486880",
  72. "FlowProportion": 0.35
  73. }
  74. ]
  75. },
  76. "StartTime": "2018-10-03T16:00:00Z",
  77. "Url500List": {
  78. "UrlList": [
  79. {
  80. "VisitData": "161673",
  81. "UrlDetail": "http://example9.com/nn_live/nn_x64/aWQ9SE5KU0GNfbGl2ZQ,,/HNJSMPP360.m3u8",
  82. "VisitProportion": 0.35,
  83. "Flow": "460486880",
  84. "FlowProportion": 0.35
  85. },
  86. {
  87. "VisitData": "3",
  88. "UrlDetail": "http://example10.com/nn_live/nn_x64/aWQ9SE5KU01QUDZXg9MQ,,/HNJSMPP360.ts",
  89. "VisitProportion": 0.35,
  90. "Flow": "460486880",
  91. "FlowProportion": 0.35
  92. }
  93. ]
  94. }
  95. }

Error codes

Error code Error message HTTP status code Description
Throttling Request was denied due to request throttling. 503 The error message returned when the request was denied due to throttling.
IllegalOperation Illegal domain, operation is not permitted. 403 The error message returned when the domain name is invalid and operations cannot be performed.
OperationDenied Your account does not open CDN service yet. 403 The error message returned when the CDN service is not enabled.
OperationDenied Your CDN service is suspended. 403 The error message returned when the CDN service has been suspended.
InvalidDomain.NotFound The domain provided does not belong to you. 404 The error message returned when the specified domain name does not exist or does not belong to you.
InvalidDomain.Offline The domain provided is offline. 404 The error message returned when the domain name is offline.
ServiceBusy The specified Domain is configuring, please retry later. 403 The error message returned when the domain name is being configured. Please try again later.
InvalidDomain.Configure_failed Failed to configure the provided domain. 500 The error message returned when the domain name failed to be configured.
MissingParameter The specified value of parameter StartTime is not valid. 400 The error message returned when the StartTime parameter is not specified.
InvalidStartTime.Malformed Specified start time is malformed. 400 The error message returned when the format of the start time is incorrect.
InvalidStartTime.ValueNotSupported Specified end time does not math the specified start time. 400 The error message returned when the duration specified by the StartTime and EndTime parameters exceeds 90 days.