DescribeUrlObservationData - Edge Security Acceleration - Alibaba Cloud Documentation Center

Queries web page observation quality data.

Operation description

If you do not specify StartTime and EndTime, this operation returns data from the past 24 hours. If you specify StartTime and EndTime, this operation returns data for the specified time range.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:DescribeUrlObservationData

none

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request syntax

POST / HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
SiteId	string	Yes	The site ID. You can call the ListSites operation to obtain the site ID.	54362329990032
StartTime	string	No	The start time for the data 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
EndTime	string	No	The end time for the data 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-19T15:59:59Z
Url	string	No	The URL of the web page to monitor.	example.com/test
ClientPlatform	string	No	The device platform. If this parameter is left empty, data for all platforms is queried. PC Mobile Valid values: PC : Desktop. Mobile : Mobile.	PC
Metric	string	No	The metric to query. TTFB: Measures the time from when a resource request is initiated to when the first byte of the response begins to arrive. FCP: Measures the time from when the page starts loading to when any part of the page content is rendered on the screen. LCP: Reports the render time of the largest image or text block visible within the viewport. CLS: A metric that measures the largest burst of layout shift scores for every unexpected layout shift that occurs throughout the entire lifecycle of a page. INP: Measures the responsiveness of a page, specifically how long it takes for the page to visibly respond to user input. FID: Measures the time from when a user first interacts with a page to when the browser is actually able to begin processing event handlers in response to that interaction.	TTFB

Response elements

Element	Type	Description	Example
	object	Schema of Response
UrlDetailData	array<object>	The returned data.
	object
Url	string	The URL of the web page to monitor.	example.com/test
ClientPlatform	string	The device platform.	PC
Country	string	The country.	CN
TTFB	number	The time from when a resource request is initiated to when the first byte of the response begins to arrive. Unit: ms.	123
FCP	number	The time from when the page starts loading to when any part of the page content is rendered on the screen. Unit: ms.	123
LCP	number	The render time of the largest image or text block visible within the viewport. Unit: ms.	123
CLS	number	The metric that measures the largest burst of layout shift scores for every unexpected layout shift that occurs throughout the entire lifecycle of a page.	0.5
FID	number	The time from when a user first interacts with a page to when the browser is actually able to begin processing event handlers in response to that interaction. Unit: ms.	123
INP	number	The responsiveness of a page, specifically how long it takes for the page to visibly respond to user input. Unit: ms.	123
RequestId	string	The request ID.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
StartTime	string	The start time. The time is in the yyyy-MM-ddTHH:mm:ssZ format.	2022-11-06T16:00:00Z
EndTime	string	The end time for the data 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-19T15:59:59Z

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.