이 가이드에서는 웹 성능 데이터의 시계열을 제공하는 Chrome UX 보고서 (CrUX) History API 엔드포인트를 소개합니다. 이 데이터는 매주 업데이트되며, 25개의 데이터 포인트가 1주 간격으로 표시되어 약 6개월간의 기록을 확인할 수 있습니다.
이제 원래 CrUX API 엔드포인트의 일일 업데이트와 함께 사용하면 최신 데이터와 이전에 발생한 상황을 모두 빠르게 확인할 수 있으므로 시간 경과에 따른 웹페이지 변경사항을 확인하는 데 유용한 도구가 됩니다.
이 페이지에서 API 사용해 보기
일일 CrUX API 쿼리
CrUX API에 관한 이전 도움말에서 요약하자면 다음과 같은 방법으로 특정 출처의 필드 데이터 스냅샷을 가져올 수 있습니다.
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 }
}
}
}
이 스냅샷에는 특정 28일 수집 기간(이 경우 2022년 12월 27일부터 2023년 1월 23일까지)의 히스토그램 밀도 값과 백분위수 값이 포함됩니다.
CrUX History API 쿼리
기록 엔드포인트를 호출하려면 curl 명령어에서 URL의 queryRecord를 queryHistoryRecord로 변경합니다. 이전 호출과 동일한 CrUX API 키를 사용하면 됩니다.
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"}'
응답의 전체적인 모양은 비슷하지만 데이터가 훨씬 더 많습니다. 이제 단일 데이터 포인트 대신 75번째 백분위수 (p75) 및 히스토그램 밀도 값이 포함된 필드의 시계열이 표시됩니다.
{
"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 }
}
]
}
}
이 예에서 최대 콘텐츠 렌더링 시간 (LCP) 측정항목의 0~2, 500밀리초 버킷에 대한 densities 시계열은 [0.9190, 0.9203, 0.9194, 0.9195, 0.9183, 0.9187].입니다. 이러한 밀도는 각각 상응하는 collectionPeriods 항목 중에 관찰되었습니다. 예를 들어 다섯 번째 밀도인 0.9183은 2022년 9월 3일에 종료되는 다섯 번째 수집 기간의 밀도이고 0.9187은 그 다음 주에 종료되는 기간의 밀도입니다.
즉, https://web.dev의 예에서 마지막 시계열 항목을 해석하면 2022년 8월 14일부터 2022년 9월 10일까지 페이지 로드의 91.87% 가 2500ms 미만의 LCP 값을 보였고, 5.27% 는 2500ms~4000ms 사이의 값을 보였으며, 2.85% 는 4000ms를 초과하는 값을 보였습니다.
마찬가지로 p75 값의 시계열도 있습니다. 2022년 8월 14일부터 2022년 9월 10일까지의 LCP p75는 1377입니다. 즉, 이 수집 기간 동안 사용자 환경의 75% 는 LCP가 1, 377ms 미만이었고 25% 는 LCP가 1, 377ms를 초과했습니다.
이 예에서는 시계열 항목과 수집 기간이 6개만 나열되지만 API의 응답은 시계열 항목 25개를 제공합니다. 각 수집 기간의 종료일은 7일 간격의 토요일이므로 6개월이 적용됩니다.
주어진 응답에서 히스토그램 빈 밀도 및 p75 값의 시계열 길이는 collectionPeriods 필드의 배열 길이와 정확히 동일합니다. 이러한 배열의 색인을 기반으로 일대일 대응이 이루어집니다.
페이지 수준 데이터 쿼리
CrUX History API를 사용하면 출처 수준 데이터뿐만 아니라 이전 페이지 수준 데이터에도 액세스할 수 있습니다. 이전에는 BigQuery의 CrUX 데이터 세트 (또는 CrUX 대시보드)를 사용하여 출처 수준 데이터를 사용할 수 있었지만 페이지 수준 이전 데이터는 사이트에서 데이터를 직접 수집하고 저장하는 경우에만 사용할 수 있었습니다. 이제 새 API를 통해 이러한 이전 페이지 수준 데이터를 활용할 수 있습니다.
페이지 수준 데이터는 동일한 방식으로 쿼리할 수 있지만 페이로드에서 origin 대신 url를 사용합니다.
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/"}'
페이지 수준 (및 출처 수준) 이전 데이터에는 나머지 CrUX와 동일한 자격요건이 적용되므로 특히 페이지에 전체 이전 기록이 없을 수 있습니다. 이 경우 '누락된' 데이터는 histogramTimeseries 밀도의 경우 "NaN"로, percentilesTimeseries 밀도의 경우 null로 표시됩니다. 차이가 발생하는 이유는 히스토그램 밀도가 항상 숫자인 반면 백분위수는 숫자 또는 문자열일 수 있기 때문입니다 (CLS는 숫자처럼 보이더라도 문자열을 사용함).
데이터 시각화
데이터가 왜 이런 모양을 갖게 되었을까요? 이렇게 하면 그래프를 더 쉽게 표시할 수 있습니다. 예를 들어 다음은 https://web.dev의 다음 페인트에 대한 상호작용 (INP)의 p75 값 그래프입니다.
이 선 차트에서 y축의 각 값은 p75s 시계열의 p75 값이고 x축은 시간으로, 각 수집 기간의 lastDate로 설정됩니다.
다음은 히스토그램에 3개의 구간이 있으므로 삼중 구간 차트라고 하는 히스토그램 구간 시계열의 그래프입니다.
x축은 각 수집 기간의 lastDate로 설정됩니다. 하지만 이번에는 누적 막대 그래프를 통해 INP 측정항목의 특정 범위에 해당하는 페이지 로드의 비율이 y축에 표시됩니다. p75 차트는 빠른 개요를 제공하며, 단일 차트 내에서 여러 측정항목을 추가하거나 PHONE 및 DESKTOP의 선을 모두 표시하는 것이 비교적 쉽습니다. 삼중 빈 차트는 각 수집 기간 동안 측정된 측정항목 값의 분포를 보여줍니다.
예를 들어 p75 차트는 관찰 기간 동안 https://web.dev의 INP 값이 거의 허용 가능한 수준이라고 제안하지만, 삼중 빈 차트는 페이지 로드의 일부에서 INP가 실제로 좋지 않았음을 보여줍니다. 두 차트 모두 10월 말에 시작되어 11월 중순에 수정된 성능 회귀가 있었음을 비교적 쉽게 추론할 수 있습니다.
이러한 차트를 직접 생성할 수 있도록 Colab 예시를 만들었습니다. Colab(또는 'Colaboratory')을 사용하면 브라우저 내에서 Python을 작성하고 실행할 수 있습니다. CrUX History API Colab (소스)은 Python을 사용하여 API를 호출하고 데이터를 차트로 표시합니다.
이 Colab을 사용하면 간단한 양식을 작성하여 p75 차트, 3개 구간 차트를 만들고, 표 형식으로 데이터를 가져오고, CrUX API의 요청 및 응답 쌍을 확인할 수 있습니다. 프로그래머가 아니어도 이 기능을 사용할 수 있습니다. Python 코드를 살펴보고 멋진 기능으로 수정할 수 있습니다. 즐겁게 사용하시고 발견한 내용에 관해 의견을 보내주세요.
물론 Colab 또는 Python에 국한되지 않으며 이는 이 새로운 API를 사용하는 방법의 한 가지 예일 뿐입니다. JSON 기반 HTTP 엔드포인트이므로 API는 모든 기술에서 쿼리할 수 있습니다.
결론
CrUX History API 엔드포인트가 도입되기 전에는 사이트 소유자가 CrUX에서 가져올 수 있는 이전 정보가 제한적이었습니다. BigQuery 및 CrUX 대시보드를 사용하여 월별 출처 수준 데이터를 사용할 수 있었지만 주간 데이터는 사용할 수 없었고 페이지 수준의 이전 데이터도 사용할 수 없었습니다. 사이트 소유자는 daily API를 사용하여 이 데이터를 직접 기록할 수 있지만, 측정항목의 회귀 후에야 이 데이터가 필요하다는 점이 발견되는 경우가 많았습니다.
이 CrUX History API를 도입하면 사이트 소유자가 변화하는 사이트 측정항목을 더 잘 이해하고 문제가 발생할 때 진단 도구로 사용할 수 있기를 바랍니다. 새 API를 사용하는 경우 Chrome UX Report (토론) Google 그룹에서 의견을 보내주세요.