Publié le 7 février 2023, dernière mise à jour le 11 avril 2025
Ce guide présente le point de terminaison de l'API Chrome UX Report (CrUX) History, qui fournit des séries temporelles de données sur les performances Web. Ces données sont mises à jour chaque semaine et vous permettent de consulter environ six mois d'historique, avec 40 points de données espacés d'une semaine.
Lorsqu'elle est utilisée avec les mises à jour quotidiennes du point de terminaison de l'API CrUX , vous pouvez désormais consulter rapidement les données les plus récentes et ce qui s'est passé auparavant. Il s'agit donc d'un outil puissant pour visualiser les modifications apportées aux pages Web au fil du temps.
Essayer l'API sur cette page
Interroger l'API CrUX quotidienne
Pour récapituler un article précédent sur l'API CrUX, vous pouvez obtenir un instantané des données réelles pour une origine spécifique de la manière suivante :
API_KEY="[YOUR_API_KEY]"
curl "https://chromeuxreport.googleapis.com/v1/records:queryRecord?key=$API_KEY" --header 'Content-Type: application/json' --data '{"origin": "https://web.dev"}'
{
"record": {
"key": {
"origin": "https://web.dev"
},
"metrics": {
"largest_contentful_paint": {
"histogram": [{
"start": 0, "end": 2500, "density": 0.9192
}, {
"start": 2500, "end": 4000, "density": 0.0513
}, {
"start": 4000, "density": 0.0294
}],
"percentiles": {
"p75": 1303
}
}
// ...
},
"collectionPeriod": {
"firstDate": { "year": 2022, "month": 12, "day": 27 },
"lastDate": { "year": 2023, "month": 1, "day": 23 }
}
}
}
Cet instantané inclut les valeurs de densité de l'histogramme et les valeurs de centile pour une période de collecte spécifique de 28 jours, en l'occurrence du 27 décembre 2022 au 23 janvier 2023.
Interroger l'API CrUX History
Pour appeler le point de terminaison de l'historique, remplacez queryRecord dans l'URL par queryHistoryRecord dans la commande curl. Vous pouvez utiliser la même
clé API CrUX que pour l'appel précédent.
collectionPeriodCount spécifie le nombre d'entrées de séries temporelles à renvoyer. La valeur maximale est 40. Si aucune valeur n'est spécifiée, la valeur par défaut est 25.
API_KEY="[YOUR_API_KEY]"
curl "https://chromeuxreport.googleapis.com/v1/records:queryHistoryRecord?key=$API_KEY" \
--header 'Content-Type: application/json' \
--data '{"origin": "https://web.dev", "collectionPeriodCount": 40}'
La forme générale d'une réponse est similaire, mais elle contient beaucoup plus de données. Au lieu d'un seul point de données, il existe désormais des séries temporelles pour les champs contenant le 75e centile (p75) et les valeurs de densité de l'histogramme.
{
"record": {
"key": {
"origin": "https://web.dev"
},
"metrics": {
"largest_contentful_paint": {
"histogramTimeseries": [{
"start": 0, "end": 2500, "densities": [
0.9190, 0.9203, 0.9194, 0.9195, 0.9183, 0.9187
]
}, {
"start": 2500, "end": 4000, "densities": [
0.0521, 0.0513, 0.0518, 0.0518, 0.0526, 0.0527
]
}, {
"start": 4000, "densities": [
0.0288, 0.0282, 0.0286, 0.0285, 0.0290, 0.0285
]
}
],
"percentilesTimeseries": {
"p75s": [
1362, 1352, 1344, 1356, 1366, 1377
]
}
}
// ...
},
"collectionPeriods": [{
"firstDate": { "year": 2022, "month": 7, "day": 10 },
"lastDate": { "year": 2022, "month": 8, "day": 6 }
}, {
"firstDate": { "year": 2022, "month": 7, "day": 17 },
"lastDate": { "year": 2022, "month": 8, "day": 13 }
}, {
"firstDate": { "year": 2022, "month": 7, "day": 24 },
"lastDate": { "year": 2022, "month": 8, "day": 20 }
}, {
"firstDate": { "year": 2022, "month": 7, "day": 31 },
"lastDate": { "year": 2022, "month": 8, "day": 27 }
}, {
"firstDate": { "year": 2022, "month": 8, "day": 7 },
"lastDate": { "year": 2022, "month": 9, "day": 3 }
}, {
"firstDate": { "year": 2022, "month": 8, "day": 14 },
"lastDate": { "year": 2022, "month": 9, "day": 10 }
}
]
}
}
Dans cet exemple, la série temporelle densities pour le bucket de 0 à 2 500 ms de la métrique
Largest Contentful Paint (LCP) est
[0.9190, 0.9203, 0.9194, 0.9195, 0.9183, 0.9187]. Chacune de ces densités a été
observée lors de l'entrée collectionPeriods correspondante. Par exemple, la cinquième densité, 0,9183, correspondait à la densité de la cinquième période de collecte, qui s'est terminée le 3 septembre 2022, et 0,9187 correspondait à la densité de la période qui s'est terminée la semaine suivante.
En d'autres termes, en interprétant les dernières entrées de séries temporelles de l'exemple pour web.dev, il a été constaté que du 14 août 2022 au 10 septembre 2022, 91,87% des chargements de page avaient des valeurs LCP inférieures à 2 500 ms, 5,27% avaient des valeurs comprises entre 2 500 ms et 4 000 ms, et 2,85% avaient des valeurs supérieures à 4 000 ms.
De même, il existe une série temporelle pour les valeurs p75 : le LCP p75 du 14 août 2022 au 10 septembre 2022 était 1377. Cela signifie que, pour cette période de collecte, 75% des expériences utilisateur avaient un LCP inférieur à 1 377 ms, et 25% des expériences utilisateur avaient un LCP supérieur à 1 377 ms.
Bien que l'exemple ne répertorie que six entrées de séries temporelles et périodes de collecte,
les réponses de l'API fournissent 25 entrées de séries temporelles par défaut et un maximum de
40, lorsque "collectionPeriodCount": 40 est spécifié dans la requête. Étant donné que les
dates de fin de chacune de ces périodes de collecte sont des samedis espacés de sept jours
, avec "collectionPeriodCount": 40, cela couvre 10 mois.
Dans une réponse donnée, la longueur de la série temporelle pour les densités de bucket d'histogramme et pour les valeurs p75 sera exactement la même que la longueur du tableau dans le champ collectionPeriods : il existe une correspondance un-à-un basée sur l'index dans ces tableaux.
Interroger les données au niveau de la page
En plus des données au niveau de l'origine, l'API CrUX History permet d'accéder aux données historiques au niveau de la page. Alors que les données au niveau de l'origine étaient disponibles précédemment à l'aide de l' ensemble de données CrUX sur BigQuery, les données historiques au niveau de la page n'étaient disponibles que si les sites collectaient et stockaient eux-mêmes les données. La nouvelle API déverrouille désormais ces données historiques au niveau de la page.
Les données au niveau de la page peuvent être interrogées de la même manière, mais en utilisant url au lieu de origin dans la charge utile :
API_KEY="[YOUR_API_KEY]"
curl "https://chromeuxreport.googleapis.com/v1/records:queryHistoryRecord?key=$API_KEY" \
--header 'Content-Type: application/json' \
--data '{"url": "https://web.dev/blog/"}'
Les données historiques au niveau de la page (et de l'origine) sont soumises aux
mêmes exigences d'éligibilité que le
reste de CrUX. Par conséquent, les pages en particulier peuvent ne pas disposer d'un enregistrement historique
complet. Dans ce cas, les données "manquantes" seront représentées par "NaN" pour les
histogramTimeseries densités et null pour les percentilesTimeseries. La raison de cette différence est que les densités d'histogramme sont toujours des nombres, tandis que les centiles peuvent être des nombres ou des chaînes (CLS utilise des chaînes, même si elles ressemblent à des nombres).
Visualiser les données
Le moyen le plus simple de visualiser les données consiste à utiliser CrUX Vis, un outil spécialement conçu pour démontrer la puissance de l'API CrUX History. Pour en savoir plus, consultez la documentation CrUX Vis.
Pour générer vous-même des graphiques similaires, nous avons créé un exemple Colab. Un Colab (ou "Colaboratory") vous permet d'écrire et d'exécuter du code Python dans votre navigateur. Le Colab de l'API CrUX History (source) utilise Python pour effectuer des appels à l'API et représenter les données sous forme de graphique.
Ce Colab vous permet de créer des graphiques p75, des graphiques à trois buckets, d'obtenir des données sous forme de tableau et de consulter la paire requête/réponse pour l'API CrUX en remplissant un bref formulaire. Vous n'avez pas besoin d'être programmeur pour l'utiliser, mais vous pouvez consulter le code Python et le modifier pour en faire quelque chose d'incroyable.
Ce n'est qu'un exemple d'utilisation de cette nouvelle API. En tant que point de terminaison HTTP basé sur JSON, l'API peut être interrogée à partir de n'importe quelle technologie.
Conclusion
Avant l'introduction du point de terminaison de l'API CrUX History, les propriétaires de sites étaient limités dans les informations historiques qu'ils pouvaient obtenir de CrUX. Les données mensuelles au niveau de l'origine étaient disponibles à l'aide de BigQuery, mais les données hebdomadaires n'étaient pas disponibles, pas plus que les données historiques au niveau de la page. Les propriétaires de sites pouvaient enregistrer eux-mêmes ces données à l'aide de l'API quotidienne, mais souvent, ce n'est qu'après une régression des métriques qu'ils en ont eu besoin.
L'objectif de l'introduction de cette API CrUX History est de permettre aux propriétaires de sites de mieux comprendre l'évolution des métriques de leur site et de disposer d'un outil de diagnostic en cas de problème. Si vous utilisez la nouvelle API, n'hésitez pas à nous faire part de vos commentaires dans le groupe Google rapport UX Chrome (Discussions).