Chrome UX Report API

Questions & Answers

What is the Chrome UX Report API?

The Chrome UX Report (CrUX) API provides programmatic, low-latency access to aggregated real-user experience data for web pages and origins. It delivers daily updated metrics, including Core Web Vitals, based on actual Chrome user traffic.

Who should use the CrUX API?

The CrUX API is primarily for web developers, performance engineers, and site owners who need to monitor and analyze real-user performance metrics programmatically. It is useful for integrating performance data into dashboards or automated reporting systems.

How does the CrUX API differ from other performance tools?

Unlike lab-based tools that simulate user conditions, the CrUX API provides field data, reflecting actual user experiences under real-world conditions. It aggregates data from a large sample of Chrome users, offering a broad view of performance at low latency.

When is it appropriate to use the Chrome UX Report API?

Use the CrUX API when you need to fetch specific, up-to-date real-user performance metrics for a URL or an entire origin. It is suitable for daily performance monitoring, identifying trends, or programmatically checking Core Web Vitals compliance.

How do I get data for a specific page using the CrUX API?

To get data for a specific page, you must use its full URL as the identifier in your API request. If an origin is specified, the API aggregates data from all pages under that origin. An API key is required for all requests.