DescribeUrlObservationData - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries the page monitoring data.

Operation description

If you do not specify the StartTime or EndTime parameter, this operation returns the data collected within the last 24 hours. If you specify both parameters, this operation 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
esa:DescribeUrlObservationData	none	*Site `acs:esa:{#regionId}:{#accountId}:site/{#SiteId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
SiteId	string	Yes	The website ID, which can be obtained by calling the ListSites operation.	54362329990032
StartTime	string	No	The beginning of the time range to query. 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
EndTime	string	No	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. The time must be in UTC.	2023-04-19T15:59:59Z
Url	string	No	The URL of the web page to monitor.	example.com/test
ClientPlatform	string	No	The platform of the device. If the parameter is left empty, all devices are queried. PC Mobile	PC
Metric	string	No	The metric data that is detected. TTFB: Measures the time between when a resource initiates a request and when the first byte of the response starts to arrive. FCP: Measures the time between when the page is loaded and when any part of the page's content is rendered on the screen. LCP: Reports the rendering time of the largest image or text block visible in the viewport. CLS: A metric that measures the maximum layout mutation score for every unexpected layout change that occurs throughout the life of the page. INP: Measures the responsiveness of the page, or how long it takes for the page to respond to user input in a visible way. FID: Measures the time between when the user first interacts with the page and when the browser is actually able to start processing the event handler in response to that interaction.	TTFB

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
UrlDetailData	array<object>	The objects that are returned.
content	object
Url	string	The URL of the web page to monitor.	example.com/test
ClientPlatform	string	The platform of the device.	PC
Country	string	The country or region to which the IP address belongs.	CN
TTFB	float	This metric measures the time between when a resource initiates a request and when the first byte of the response starts to arrive. Unit: ms.	123
FCP	float	Measures the time between when the page is loaded and when any part of the page's content is rendered on the screen. Unit: ms.	123
LCP	float	Reports the rendering time of the largest image or text block visible in the viewport. Unit: ms.	123
CLS	float	Measures the maximum layout mutation score for every unexpected layout change that occurs throughout the life of the page.	0.5
FID	float	Measures the time between when the user first interacts with the page and when the browser is actually able to start processing an event handler in response to that interaction. Unit: ms.	123
INP	float	Measures the responsiveness of the page, or how long it takes for the page to respond to user input visibly. Unit: ms.	123
RequestId	string	The request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
StartTime	string	The create time. The time is in the yyyy-MM-ddTHH:mm:ssZ format.	2022-11-06T16:00:00Z
EndTime	string	The end of the time range during which data was queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The time must be in UTC.	2023-04-19T15:59:59Z

Examples

Sample success responses

JSONformat

{
  "UrlDetailData": [
    {
      "Url": "example.com/test",
      "ClientPlatform": "PC",
      "Country": "CN",
      "TTFB": 123,
      "FCP": 123,
      "LCP": 123,
      "CLS": 0.5,
      "FID": 123,
      "INP": 123
    }
  ],
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "StartTime": "2022-11-06T16:00:00Z",
  "EndTime": "2023-04-19T15:59:59Z"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.TimeRange	The specified time range exceeds the limit. Adjust it and try again.	The specified time range exceeds the limit. Adjust it and try again.
400	TooManyRequests	Too many requests.Please try again later.	Requests are too frequent, please try again later.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time you entered is earlier than the start time. Please check and try again.
400	InvalidParameter	Parameter verification failed. Check your configurations and try again.	Parameter verification failed. Check your configurations and try again.
400	InvalidTime.Malformed	Specified 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.

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