Using the Chrome UX Reporting API

the Chrome UX Report El conjunto de datos (CrUX) representa cómo los usuarios de Chrome en el mundo real experimentan los destinos populares en la web. Desde 2017, cuando el conjunto de datos consultables se lanzó por primera vez en BigQuery, los datos de campo de CrUX se han integrado en herramientas para desarrolladores como PageSpeed ​​Insights, CrUX DashboardConcepto de Dashboard¿Qué es un Dashboard?Un Dashboard, término inglés que se traduce normalmente como panel de instrumentos o salpicadero, es una gráfica que enseña los indicadores fundamentales implicados al momento de obtener una serie de objetivos determinados en un negocio. Su uso está orientado a ayudar al momento de realizar decisiones con las que mejorar la estrategia empresarial, poniendo de manifiesto datos útiles.Su elaboración es un tema que requiere de plus and Search Console¿Qué es Search console?Servicio sin costes ofrecido por Google que ayuda a supervisar y a mantener la presencia de un portal web en los resultados de búsqueda, así como a aprovechar al máximo su visibilidad. Conocido anteriormente como Webmaster Central y Google Webmaster tools, proporciona herramientas y recursos para monitorizar la apariencia de búsqueda, el tráfico de búsqueda, el estado técnico o los errores de rastreo, entre otras funcionalidades. plus. Core Web Vitals Report, lo que permite a los desarrolladores medir y monitorear fácilmente las experiencias de los usuarios reales. La pieza que ha faltado todo este tiempo ha sido una herramienta que proporciona acceso gratuito y RESTful a los datos de CrUX mediante programmingConcepto de Programación¿Qué es la Programación?La Programación es el procedimiento al que se recurre para crear algún tipo de aplicación o software, para materializar un concepto o proyecto que requiere de la utilización de un lenguaje informático para poder llevarse a cabo. Es algo que está absolutamente ligado a la figura del programador, y que cada vez está cobrando más relevancia dentro del mundo del marketing.Decimos que tanto esta figura plus. Para ayudar a cerrar esa brecha, nos complace anunciar el lanzamiento de las nuevas Chrome UX Reporting API!

Esta API se ha creado con el target¿Qué es un objetivo?En marketing, un objetivo es el resultado que se pretende alcanzar en un periodo de tiempo, a través el uso de los recursos disponibles. Por tanto, se debe formular de una forma clara y hace falta que sea accesible y medible. plus de proporcionar a los desarrolladores un acceso sencillo, rápido y completo a los datos de CrUX. La API de CrUX solo informa field user experience data, as opposed to existing PageSpeed ​​Insights API, which also informs laboratory data from Lighthouse performance audits. The CrUX API is streamlined and can quickly serve user experience data, making it ideal for real-time auditing applications.

Para garantizar que los desarrolladores tengan acceso a todas las métricas que más importan (los elementos básicos de Web Vitals), la API de CrUX audita y supervisa la pintura de contentsEl contenido puede ser muy difícil de definir con precisión. Es una definición que se refiere a las declaraciones contenidas en un documento o publicación de cualquier tipo y puede incluir las tecnologías de la información y la comunicación. Esto cubre todos los tipos de medios como imágenes y texto. A parte de esto, en el campo de la optimización de motores de búsqueda, los términos duplicar contenido, contenido único, plus más grande (LCP), el retraso de la primera entrada (FID) y el cambio de diseño acumulativo (CLS) en ambos el origen y el nivel de UrlEl URL (Localizador Uniforme de Recursos), es una dirección definida que apunta a la posición de un archivo en un servidor y lo recupera. Las URL se introducen en un navegador web para ingresar a documentos en la web o se incrustan como hipervínculos dentro de un documento. Se puede usar un Permalink para que una URL esté disponible de forma permanente. Componentes de una URL • prefijo de protocolo plus.

So let's dive in and see how to use it!

Source data query

The origins in the CrUX dataset span all the underlying experiences at the page level. The following example demonstrates how to query the CrUX API to get user experience data from a source using cURL on the command line.

API_KEY="[YOUR_API_KEY]"
curl "httpsHTTPS (protocolo de Transferencia de Hiper-Texto) es un protocolo que permite determinar una conexión segura entre el servidor y el cliente, que no puede ser interceptada por personas no autorizadas. En resumidas cuentas, es la versión segura de el http (Hyper Text Transfer Protocol) Cómo funciona Una conexión HTTP estándar en Internet puede ser fácilmente secuestrada por partes no autorizadas. El propósito de una conexión HTTPS es evitar esto: encriptar plus://chromeuxreport.googleapis.com/v1/records:queryRecord?key=$API_KEY" 
  --header 'Content-Type: application/json' 
  --data '{"origin": "https://web.dev"}'

Run this query interactively on the CrUX API Explorer.

the curl The command consists of three parts:

1. The endpoint of the API URL, including the caller's private API key.
2. the Content-Type: application / json header, which indicates that the request body contains JSON.
3. The JSON encoding request body, specifying the https://web.dev source.

Para hacer lo mismo en JavaScriptJavaScript es un lenguaje de programación que funciona en el lado del cliente y con el que las webs pueden ser más funcionales. Incorporación en código HTML El código JavaScript puede ser incrustado en las páginas HTML, para que adquieran funcionalidad. Existen varias opciones. Puede estar entre las etiquetas <SCRIPT> y </SCRIPT>, puede estar contenido en un archivo externo, puede ser un parámetro de las etiquetas HTML, y puede estar plus, use el CrUXApiUtil utility, which makes the API call and returns the decoded response.

const CrUXApiUtil = {};

CrUXApiUtil.API_KEY = '[YOUR_API_KEY]';
CrUXApiUtil.API_ENDPOINT = `https://chromeuxreport.googleapis.com/v1/records:queryRecord?key=${CrUXApiUtil.API_KEY}`;
CrUXApiUtil.queryConcepto de Query¿Qué es una Query?Una query, en inglés, es una definición que significa pregunta. Trasladando este concepto al marketing digital y a internet, se traduce como el concepto que un usuario escribe en un buscador, véase Google, cuando desea realizar una búsqueda usando keywords o palabras clave. Es la serie de términos reales que se utilizan al momento de ir en busca de información en estos portales.Cuando un consumidor más = function (requestBody) {
  if (CrUXApiUtil.API_KEY == '[YOUR_API_KEY]') {
    throw 'Replace "YOUR_API_KEY" with your private CrUX API key. Get a key at https://goo.gle/crux-api-key.';
  }
  return fetch(CrUXApiUtil.API_ENDPOINT, {
    method: 'POST',
    body: JSON.stringify(requestBody)
  }).then(response => response.json()).then(response => {
    if (response.error) {
      return Promise.reject(response);
    }
    return response;
  });
};

Replace [YOUR_API_KEY] with your wrench. Then call CrUXApiUtil.query function and pass in the request body object.

CrUXApiUtil.query({
  origin: 'https://web.dev'
}).then(response => {
  console.log(response);
}).catch(response => {
  console.error(response);
});

If data exists for this source, the API response is a JSON-encoded object that contains metrics A representing the distribution of user experiences. The distribution metrics are histogram intervals and percentiles.

{
  "record": {
    "key": {
      "origin": "https://web.dev"
    },
    "metrics": {
      "largest_contentful_paint": {
        "histogram": [
          {
            "start": 0,
            "end": 2500,
            "density": 0.7925068547983514
          },
          {
            "start": 2500,
            "end": 4000,
            "density": 0.1317422195536863
          },
          {
            "start": 4000,
            "density": 0.07575092564795324
          }
        ],
        "percentiles": {
          "p75": 2216
        }
      },
      
    }
  }
}

the start and end properties of histogram The object represents the range of values that users experience for the given metric. the density The property represents the proportion of user experiences within that range. In this example, the 79% of LCP user experiences on all web.dev pages are below 2500 milliseconds, which is the "good" LCP threshold. the percentiles.p75 The value means that the 75% of user experiences in this distribution is less than 2216 milliseconds. Learn more about the response structure in the response body documentation.

Mistakes

When the CrUX API doesn't have any data for a given origin, it responds with a JSON-encoded error message:

{
"error": {
"code": 404,
"message": "chrome ux report data not found",
"status": "NOT_FOUND"
}
}

Para depurar este error, primero verifique que el origen solicitado sea navegable públicamente. Puede probar esto ingresando el origen en la barra de URL de su browserUn navegador (además: browser) es una herramienta informática que te permite ver documentos y datos y navegar por la red. Los navegadores pueden mostrar distintos tipos de recursos de información; principalmente documentos HTML, a pesar de todo, además son posibles otros tipos de archivos y contenido multimedia, como PDF, JPEG, MPEG, GIF o el lenguaje de meta marcado. A través el uso de complementos especiales y la configuración respectivo, los plus y comparándolo con la URL final después de cualquier redirectUn redirect (abreviatura de redirección) es un reenvío automático del lado del servidor o del cliente de una URL a otra. Las redirecciones se usan para múltiples fines, como la reubicación de un portal web en un nuevo dominio o el mantenimiento de un servidor. Con un 301-redirect, el contenido duplicado puede, por ejemplo, ser evitado. Antecedentes Una redirección suele ser siempre automática y apenas percibida por el usuario. Sobre plus. Los problemas comunes incluyen agregar u omitir innecesariamente el subdomainConcepto de Subdominio¿Qué es un Subdominio?Un Subdominio es una extensión que se añade al nombre de un dominio para organizar las distintos secciones que pueda tener su web, aún cuando funcionando de forma totalmente independiente a esta. Por lo general, generalmente son palabras que lo preceden y que se separan de él utilizando un punto para remarcar tanto su independencia como la idea de que son algo desligado del contenido plus y usar el protocolo HTTPEl HTTP (Hyper Text Transfer Protocol) es un protocolo que se usa para transmitir datos en redes. HTTP es un estándar técnico generalmente aceptado que establece cómo un cliente web se comunica con un servidor para que los datos solicitados por el cliente puedan ser cargados y mostrados. Información general Junto con el URL y el HTML, HTTP es uno de los conceptos más importantes de Internet (www). Fue desarrollado plus incorrecto.

{"origin": "http://www.web.dev"}

{"origin": "https://web.dev"}

If the requested origin it is the browsable version, this error can also occur if the source has an insufficient number of samples. All sources and URLs included in the dataset must have a sufficient number of samples to anonymize individual users. Also, the origins and URLs must be publicly traceable. Refer to CrUX methodology for more information on how websites are included in the dataset.

URL data query

You have seen how to query the CrUX API for the overall user experience in a source. To restrict the results to a particular page, use the url request parameter.

API_KEY="[YOUR_API_KEY]"
curl "https://chromeuxreport.googleapis.com/v1/records:queryRecord?key=$API_KEY" 
  --header 'Content-Type: application/json' 
  --data '{"url": "https://web.dev/fast/"}'

This cURL command is similar to the source example, except that the request body uses the url parameter to specify the page to search for.

To query URL data from the CrUX API in JavaScript, call CrUXApiUtil.query function using the url parameter in the request body.

CrUXApiUtil.query({
  url: 'https://web.dev/fast/'
}).then(response => {
  console.log(response);
}).catch(response => {
  console.error(response);
});

If data for this URL exists in the CrUX dataset, the API will return a JSON-encoded response like the one shown below.

{
  "record": {
    "key": {
      "url": "https://web.dev/fast/"
    },
    "metrics": {
      "largest_contentful_paint": {
        "histogram": [
          {
            "start": 0,
            "end": 2500,
            "density": 0.8477304539092148
          },
          {
            "start": 2500,
            "end": 4000,
            "density": 0.08988202359528057
          },
          {
            "start": 4000,
            "density": 0.062387522495501155
          }
        ],
        "percentiles": {
          "p75": 1947
        }
      },
      
    }
  }
}

True to form, the results show that https://web.dev/fast/ it has an 85% of "good" LCP experiences and a 75th percentile of 1,947 milliseconds, which is slightly better than the whole source distribution.

URL normalization

The CrUX API can normalize the requested URLs to better match the list of known URLs. For example, query the URL https://web.dev/fast/#measure-performance-in-the-field will result in data for https://web.dev/fast/ due to standardization. When this happens, a urlNormalizationDetails The object will be included in the response.

{
  "record": {
    "key": {
      "url": "https://web.dev/fast/"
    },
    "metrics": { ... }
  },
  "urlNormalizationDetails": {
    "normalizedUrl": "https://web.dev/fast/",
    "originalUrl": "https://web.dev/fast/#measure-performance-in-the-field"
  }
}

Learn more about URL normalization in the CrUX documentation.

Query by form factor

User experiences can vary significantly based on website optimizations, network conditions, and user devices. To better understand these differences, dig into the origin and performance of the URL using the formFactor CrUX API dimension.

The API supports three explicit form factor values: DESKTOP, PHONEand TABLET. In addition to the origin or URL, specify one of these values in the request body to restrict results to user experiences only. The following example demonstrates how to query the API by form factor using cURL.

API_KEY="[YOUR_API_KEY]"
curl "https://chromeuxreport.googleapis.com/v1/records:queryRecord?key=$API_KEY" 
  --header 'Content-Type: application/json' 
  --data '{"url": "https://web.dev/fast/", "formFactor": "PHONE"}'

To query the CrUX API for form factor specific data using JavaScript, call CrUXApiUtil.query function using the url and formFactor parameters in the request body.

CrUXApiUtil.query({
  url: 'https://web.dev/fast/',
  formFactor: 'PHONE'
}).then(response => {
  console.log(response);
}).catch(response => {
  console.error(response);
});

Skipping the formFactor parameter is equivalent to requesting data for all form factors combined.

{
  "record": {
    "key": {
      "url": "https://web.dev/fast/",
      "formFactor": "PHONE"
    },
    "metrics": {
      "largest_contentful_paint": {
        "histogram": [
          {
            "start": 0,
            "end": 2500,
            "density": 0.778631284916204
          },
          {
            "start": 2500,
            "end": 4000,
            "density": 0.13943202979515887
          },
          {
            "start": 4000,
            "density": 0.08193668528864119
          }
        ],
        "percentiles": {
          "p75": 2366
        }
      },
    
    }
  }
}

the key the response field will echo the formFactor Request setup to confirm that only phone experiences are included.

Recuerde de la sección anterior que el 85% de las experiencias de los usuarios en esta página tenían un LCP «bueno». Compare eso con las experiencias específicas del teléfono, de las cuales solo el 78% se consideran «buenas». El percentil 75 también es más lento entre las experiencias telefónicas, pasando de 1.947 milisegundos a 2.366 milisegundos. La segmentation"Segmentación" por definición significa descomponer en fracciones de menores dimensiones un grupo y se aplica a distintos ámbitos: • En biología, una lombriz se compone por distintos segmentos • En literatura, las palabras, las frases se dividen en segmentos y unidades menores • En IT la memoria además se divide en muchos segmentos • En economía, el término segmentación de mercado se basa en productos y clientes Criterios de Segmentación plus por factor de forma tiene el potencial de resaltar disparidades más extremas en las experiencias de los usuarios.

Core Web Vitals performance evaluation

The Core Web Vitals program defines goals that help determine whether a user experience or distribution of experiences can be considered "good." In the following example, we use the CrUX API and the CrUXApiUtil.query function to evaluate whether the distribution of Core Web Vitals metrics (LCP, FID, CLS) of a web page is "good".

CrUXApiUtil.query({
  url: 'https://web.dev/fast/'
}).then(response => {
  assessCoreWebVitals(response);
}).catch(response => {
  console.error(response);
});

function assessCoreWebVitals(response) {
  
  const CORE_WEB_VITALS = [
    'largest_contentful_paint',
    'first_input_delay',
    'cumulative_layout_shift'
  ];
  CORE_WEB_VITALS.forEach(metric => {
    const data = response.record.metrics[metric];
    if (!data) {
      console.log('No data for', metric);
      return;
    }
    const p75 = data.percentiles.p75;
    const threshold = data.histogram[0].end;
    
    
    const passes = p75 < threshold;
    console.log(`The 75th percentile (${p75}) of ${metric} ` +
        `${passes ? 'passes' : 'does not pass'} ` +
        `the Core Web Vitals "good" threshold (${threshold}).`)
  });
}

The results show that this page passes the Core Web Vitals assessments for all three metrics.

The 75th percentile (1973) of largest_contentful_paint passes the Core Web Vitals "good" threshold (2500).
The 75th percentile (20) of first_input_delay passes the Core Web Vitals "good" threshold (100).
The 75th percentile (0.05) of cumulative_layout_shift passes the Core Web Vitals "good" threshold (0.10).

Combined with an automated way of monitoring API results, CrUX data can be used to ensure that user experiences get fast and stay fast. For more information on Core Web Vitals and how to measure them, see Web Vitals and Tools for Measuring Core Web Vitals.

Whats Next?

The features included in the initial release of the CrUX API only scratch the surface of the types of information that are possible with CrUX. Users of the CrUX dataset in BigQuery may be familiar with some of the more advanced features, including:

• Additional metrics
  • first_paint
  • dom_content_loaded
  • onload
  • time_to_first_byte
  • notification_permissions
• Additional dimensions
  • month
  • country
  • effective connection type (ECT)
• Additional granularity
  • detailed histograms
  • more percentiles

Over time, we hope to integrate more of these features with the ease of use and free pricing of the CrUX API to enable new ways to explore data and discover insights into the state of user experiences on the web.

Take a look at the official CrUX API documents to acquire your API key and explore more sample applications. We hope you give it a try and would love to hear any questions or comments you may have, so reach out to us at CrUX discussion forum. And to stay up to date with everything we have planned for the CrUX API, subscribe to CrUX Ads Forum o síguenos en TwitterTwitter es una red social en Internet que permite a los usuarios difundir información en tiempo real. La característica más notable de twitter solía ser su limitación de tweets a 140 caracteres, pero en septiembre de 2017 se incrementó a 280 caracteres. El único requerimiento para utilizar Twitter es la creación de una cuenta gratuita. Tweets Twitter contiene pequeñas piezas de información llamada tweets. Se puede escribir un máximo de plus in @ChromeUXReport.