CrUX 기록 API

CrUX History API를 사용하면 6개월 동안의 실제 사용자 경험 데이터를 페이지 및 출처별로 짧은 지연 시간으로 액세스할 수 있습니다.

일반적인 사용 사례

CrUX History API를 사용하면 'https://example.com 출처의 이전 UX 트렌드 가져오기'와 같이 특정 URI의 이전 사용자 환경 측정항목을 쿼리할 수 있습니다.

History API는 값이 배열로 제공되고 키에 복수형 이름 (예: histogram 대신 histogramTimeseries 또는 p75 대신 p75s)이 지정되는 점을 제외하고 일일 CrUX API와 동일한 구조를 따릅니다.

CrUX API 키

Daily API와 마찬가지로 CrUX History API를 사용하려면 Google Cloud API 키가 필요합니다. 일일 API와 기록 API에 동일한 키를 사용할 수 있습니다.

사용자 인증 정보 페이지에서 계정을 만들고 Chrome UX Report API 사용을 위해 프로비저닝할 수 있습니다.

API 키가 있으면 애플리케이션에서 쿼리 매개변수 key=[YOUR_API_KEY]을 모든 요청 URL에 추가할 수 있습니다. 쿼리 예를 참고하세요.

API 키는 URL에 포함하기에 안전합니다. 인코딩이 전혀 필요하지 않습니다.

데이터 모델

이 섹션에서는 요청 및 응답의 데이터 구조를 자세히 설명합니다.

레코드

페이지 또는 사이트에 대한 별개의 정보입니다. 레코드에는 식별자 및 특정 측정기준 조합에 관한 데이터가 포함될 수 있습니다. 레코드에는 하나 이상의 측정항목에 대한 데이터가 포함될 수 있습니다.

식별자

식별자는 조회해야 하는 레코드를 지정합니다. CrUX에서 이러한 식별자는 웹페이지와 웹사이트입니다.

출발지

식별자가 출처인 경우 해당 출처의 모든 페이지에 있는 모든 데이터가 함께 집계됩니다. 예를 들어 http://www.example.com 출처에 다음 사이트맵에 따라 구성된 페이지가 있다고 가정해 보겠습니다.

http://www.example.com/
http://www.example.com/foo.html
http://www.example.com/bar.html

즉, 출처가 http://www.example.com로 설정된 Chrome UX 보고서를 쿼리하면 http://www.example.com/, http://www.example.com/foo.html, http://www.example.com/bar.html 데이터가 모두 해당 출처에 속한 페이지이므로 함께 집계되어 반환됩니다.

URL

식별자가 URL인 경우 해당 URL에 대한 데이터만 반환됩니다. http://www.example.com 출처 사이트맵 다시 살펴보기:

http://www.example.com/
http://www.example.com/foo.html
http://www.example.com/bar.html

식별자를 값이 http://www.example.com/foo.html인 URL로 설정하면 해당 페이지의 데이터만 반환됩니다.

크기

측정기준은 레코드가 집계되는 특정 데이터 그룹을 식별합니다. 예를 들어 PHONE 폼 팩터는 레코드에 휴대기기에서 발생한 로드에 관한 정보가 포함되어 있음을 나타냅니다.

CrUX History API는 폼 팩터 측정기준으로 집계한 경우에만 사용할 수 있습니다. PHONE, TABLET, DESKTOP로 분할된 일반적인 기기 클래스입니다.

참고: 일일 API와 달리 CrUX History API에는 유효 연결 유형 (ECT)을 기준으로 집계된 데이터가 없습니다.

측정항목

측정항목은 히스토그램, 백분위수, 분수인 통계 집계의 시계열로 보고합니다.

히스토그램

측정항목을 히스토그램 배열로 표현할 때 각 시계열 항목은 측정항목이 간격에 속한 페이지 로드의 비율을 전체 대비 비례하여 나타냅니다. 데이터 포인트는 API에서 반환된 수집 기간 날짜 순으로 표시되며 첫 번째 시점이 가장 빠른 기간, 마지막 시점이 가장 최근의 수집 기간입니다.

예시 측정항목의 간단한 3빈 히스토그램은 다음과 같습니다.

{
  "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]
    }
  ],
}

이 데이터는 페이지 로드의 91.90% 에서 기록의 첫 번째 수집 기간 동안 0밀리초에서 2,500밀리초 사이의 예시 측정항목 값을 경험했고, 그 뒤를 이어 92.03%, 91.94%가 그 뒤를 이었습니다. 이 히스토그램에는 측정항목 단위가 포함되지 않으며 이 경우에는 밀리초로 가정합니다.

또한 페이지 로드의 5.21% 에서 기록의 첫 번째 수집 기간에 2,500ms에서 4,000ms 사이의 예시 측정항목 값이 발생했으며, 페이지 로드의 2.88% 에서 기록의 첫 번째 수집 기간에 4,000ms가 넘는 값이 발생했습니다.

백분위수

측정항목에는 추가 분석에 유용한 백분위수 시계열도 포함될 수 있습니다.

데이터 포인트는 API에서 반환된 수집 기간 날짜 순으로 표시되며 첫 번째 시점이 가장 빠른 기간, 마지막 시점이 가장 최근의 수집 기간입니다.

{
  "percentilesTimeseries": {
    "p75s": [1362, 1352, 1344, 1356, 1366, 1377]
  },
}

이러한 백분위수는 해당 측정항목의 특정 백분위수에 해당하는 특정 측정항목 값을 표시할 수 있습니다. 최종 비닝 데이터가 아닌 사용 가능한 전체 데이터 세트를 기반으로 하므로 최종 비닝된 히스토그램을 기반으로 하는 보간된 백분위수와 반드시 일치하는 것은 아닙니다.

참고: 각 백분위수의 값은 종합적으로 추출되며, 사용자가 실제로 표시된 값을 경험했다는 의미는 아닙니다. 단지 일부 사용자가 주어진 값보다 작은 측정항목 값을 경험했다는 의미일 뿐입니다.

분수

측정항목은 라벨이 지정된 분수의 시계열로 표현될 수 있습니다. 각 라벨은 특정 방식으로 페이지 로드를 설명합니다. 데이터 포인트는 API에서 반환된 수집 기간 날짜 순으로 표시되며 첫 번째 시점이 가장 빠른 기간, 마지막 시점이 가장 최근의 수집 기간입니다.

예:

{    
  "fractionTimeseries": {
    "desktop": {"fractions": [0.3195, 0.2115, 0.1421]},
    "phone": {"fractions": [0.6295, 0.7544, 0.8288]},
    "tablet": {"fractions": [0.051, 0.0341, 0.029]}
  }
}

이 예에서 최신 데이터 포인트는 페이지 로드의 14.21% 가 데스크톱에서 발생했고 82.88% 가 휴대전화에서 발생했음을 나타냅니다.

측정항목 값 유형

CrUX History API는 동일한 측정항목 값 유형을 사용하므로 일일 CrUX API 측정항목 값 유형 문서에서 자세한 내용을 확인할 수 있습니다.

측정항목 자격 요건

자격 기준에 따라 출처 또는 URL은 CrUX History API가 적용되는 수집 기간의 일부에만 적용될 수 있습니다. 이 경우 CrUX History API는 적합한 데이터가 없는 수집 기간에 대해 histogramTimeseries 밀도에 대해 "NaN"를 반환하고 percentilesTimeseries에 대해 null를 반환합니다. 차이가 생기는 이유는 히스토그램 밀도는 항상 숫자이지만 백분위수는 숫자 또는 문자열일 수 있습니다 (CLS는 숫자처럼 보이지만 문자열을 사용함).

예를 들어 두 번째 기간에 요건을 충족하는 데이터가 없는 경우 다음과 같이 표시됩니다.

{
  "histogramTimeseries": [
    {
      "start": 0,
      "end": 2500,
      "densities": [0.9190, "NaN", 0.9194, 0.9195, 0.9183, 0.9187]
    },
    {
      "start": 2500,
      "end": 4000,
      "densities": [0.0521, "NaN", 0.0518, 0.0518, 0.0526, 0.0527]
    },
    {
      "start": 4000,
      "densities": [0.0288, "NaN", 0.0286, 0.0285, 0.0290, 0.0285]
    }
  ],
  "percentilesTimeseries": {
    "p75s": [1362, null, 1344, 1356, 1366, 1377]
  },
}

시간이 지남에 따라 자격 요건을 충족하거나 상실하게 되는 URL 또는 출처의 경우 누락된 항목이 많이 표시될 수 있습니다.

수집 기간

CrUX History API에는 각 집계 기간의 시작일과 종료일을 나타내는 firstDate 및 endDate 필드의 배열이 있는 collectionPeriods 객체가 포함되어 있습니다. 예를 들면 다음과 같습니다.

    "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 }
      }
    ]

이러한 수집 기간은 오름차순으로 정렬되며 응답의 다른 섹션에 있는 각 데이터 포인트의 날짜 범위를 나타냅니다.

History API는 매주 월요일에 업데이트되며 전주 토요일까지의 데이터를 포함합니다 (표준 2일 지연에 따라). 지난 25주 동안의 데이터(주당 한 번의 수집 기간)가 포함됩니다.

각 수집 기간에는 이전 28일 간의 합산 데이터가 포함되고 수집 기간은 주 단위이므로, 이는 수집 기간이 중복됨을 의미합니다. 데이터의 이동 평균과 유사하며, 각 후속 기간에 3주 분량의 데이터가 포함되고 1주는 다릅니다.

쿼리 예

쿼리는 https://chromeuxreport.googleapis.com/v1/records:queryHistoryRecord?key=[YOUR_API_KEY]"에 대한 POST 요청을 사용하여 JSON 객체로 제출되며 쿼리 데이터는 POST 본문에 JSON 객체로 제출됩니다.

일일 CrUX API의 queryRecord를 대체하는 queryHistoryRecord가 사용되었습니다.

본문 예시는 다음과 같습니다.

{
  "origin": "https://example.com",
  "formFactor": "PHONE",
  "metrics": [
    "largest_contentful_paint",
    "experimental_time_to_first_byte"
  ]
}

예를 들어 다음 명령줄을 사용하여 curl에서 호출할 수 있습니다 (API_KEY를 키로 바꿈).

curl -s --request POST 'https://chromeuxreport.googleapis.com/v1/records:queryHistoryRecord?key=API_KEY' \
    --header 'Accept: application/json' \
    --header 'Content-Type: application/json' \
    --data '{"formFactor":"PHONE","origin":"https://www.example.com","metrics":["largest_contentful_paint", "experimental_time_to_first_byte"]}'

참고: 앞의 예는 macOS 또는 Linux 기반 시스템(Windows용 Git BASH 셸 포함)입니다. 다른 시스템은 약간의 수정이 필요할 수 있습니다. 예를 들어 cmd.exe 명령줄은 매개변수에 작은따옴표를 허용하지 않으며 줄 연속형 (\)을 사용할 수 없으므로 큰따옴표 (\"를 사용하여 적절하게 안쪽 따옴표 이스케이프 처리)를 사용하고 한 줄을 사용해야 합니다.

페이지 수준 데이터는 쿼리에 origin 대신 url 속성을 전달하여 API를 통해 사용할 수 있습니다.

{
  "url": "https://example.com/page",
  "formFactor": "PHONE",
  "metrics": [
    "largest_contentful_paint",
    "experimental_time_to_first_byte"
  ]
}

metrics 속성을 설정하지 않으면 사용 가능한 모든 측정항목이 반환됩니다.

• cumulative_layout_shift
• first_contentful_paint
• first_input_delay
• interaction_to_next_paint
• largest_contentful_paint
• experimental_time_to_first_byte
• navigation_types
• form_factors (요청에 formFactor가 지정되지 않은 경우에만 보고됨)

formFactor 값을 제공하지 않으면 값이 모든 폼 팩터에서 집계됩니다.

쿼리 예시를 더 보려면 CrUX History API 사용 가이드를 참조하세요.

데이터 파이프라인

CrUX 데이터 세트는 파이프라인을 통해 처리되어 데이터를 통합, 집계 및 필터링한 후에 API를 통해 사용할 수 있습니다.

이동 평균

Chrome UX 보고서의 데이터는 집계된 측정항목의 28일 이동 평균입니다. 즉, 특정 시점에 Chrome UX 보고서에 표시되는 데이터는 실제로 지난 28일 동안의 데이터를 합산한 것입니다.

History API에는 각각 이러한 28일에 걸친 여러 수집 기간이 포함되어 있습니다. 각 수집 기간에는 이전 28일 간의 합산 데이터가 포함되고 수집 기간은 주 단위이므로, 이는 수집 기간이 중복됨을 의미합니다. 데이터의 이동 평균과 유사하며, 각 후속 기간에 3주 분량의 데이터가 포함되고 1주는 다릅니다.

주간 업데이트

History API는 매주 월요일 오전 4시(UTC)에 업데이트되며 전주 토요일까지의 데이터를 포함합니다(표준 2일 지연에 따라). 매주 한 번의 수집 기간으로 지난 25주 (약 6개월)의 데이터가 포함됩니다.

업데이트 시간에 대한 서비스수준계약은 없으며 최선을 다해 매일 실행됩니다.

주의: 매주 월요일 오전 4시(UTC)경에 데이터가 업데이트된 후에는 같은 주 동안 데이터가 달라지지 않습니다. 반복 호출해도 동일한 결과가 나옵니다.

스키마

CrUX History API에는 POST HTTP 요청을 수락하는 단일 엔드포인트가 있습니다. API는 요청된 출처 또는 페이지의 성능 데이터에 해당하는 하나 이상의 metrics를 포함하는 record를 반환합니다.

HTTP 요청

POST https://chromeuxreport.googleapis.com/v1/records:queryHistoryRecord

URL은 gRPC 트랜스코딩 구문을 사용합니다.

요청 본문

CrUX History API는 effectiveConnectionType 요청 필드를 지원하지 않는 점을 제외하고 일일 CrUX API와 동일한 요청 본문을 사용합니다.

예를 들어 web.dev 홈페이지의 데스크톱 최대 콘텐츠 렌더링 시간 값을 요청하려면 다음 안내를 따르세요.

{
  "origin": "https://web.dev/",
  "formFactor": "DESKTOP",
  "metrics": [
    "largest_contentful_paint"
  ]
}

응답 본문

요청이 성공하면 다음과 같은 구조의 record 객체 및 urlNormalizationDetails와 함께 응답이 반환됩니다.

{
  "record": {
    "key": {
      object (Key)
    },
    "metrics": [
      string: {
        object (Metric)
      }
    ]
  },
  "urlNormalizationDetails": {
    object (UrlNormalization)
  }
}

예를 들어 이전 요청의 요청 본문에 대한 응답은 다음과 같을 수 있습니다.

{
  "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 }
      }, {
        ...
      }
    ]
  }
}

키

Key는 이 레코드를 고유한 것으로 식별하는 모든 측정기준을 정의합니다.

{
  "formFactor": enum (FormFactor),

  // Union field url_pattern can be only one of the following:
  "origin": string,
  "url": string
  // End of list of possible types for union field url_pattern.
}

입력란
formFactor	enum (FormFactor) 폼 팩터는 모든 사용자가 이 레코드를 위해 사이트에 액세스하는 데 사용한 기기 클래스입니다. 폼 팩터가 지정되지 않으면 모든 폼 팩터에서 집계된 데이터가 반환됩니다.
통합 필드 url_pattern. URL 패턴은 레코드가 적용되는 URL입니다. url_pattern은 다음 중 하나여야 합니다.
origin	string Origin은 이 레코드의 출처를 지정합니다. 참고: 출처를 지정하면 모든 페이지에서 이 출처의 로드에 대한 데이터가 출처 수준의 사용자 환경 데이터로 집계됩니다.
url	string url는 이 레코드에 해당하는 특정 URL을 지정합니다. 참고: url를 지정하면 특정 URL에 대한 데이터만 집계됩니다.

측정항목

metric는 콘텐츠가 포함된 첫 페인트와 같은 단일 웹 성능 측정항목의 사용자 환경 데이터 집합입니다. 실제 Chrome 사용에 관한 요약 히스토그램이 일련의 bins으로 포함되어 있습니다.

{
  "histogramTimeseries": [
    {
      object (Bin)
    }
  ],
  "percentilesTimeseries": {
    object (Percentiles)
  }
}

또는

"fractionTimeseries": {
  object (Fractions)
}

입력란
histogramTimeseries[]	object (Bin) 측정항목에 대한 사용자 환경의 시계열 히스토그램입니다. 시계열 히스토그램에는 하나 이상의 빈이 있으며 모든 빈의 밀도를 더하면 최대 1이 됩니다. 특정 수집 기간의 누락된 값은 "NaN"로 표시됩니다.
percentilesTimeseries	object (Percentiles) 측정항목의 일반적인 유용한 백분위수입니다. 백분위수의 값 유형은 히스토그램 빈에 지정된 값 유형과 동일합니다. 특정 수집 기간의 누락된 값은 null로 표시됩니다.
fractionTimeseries	object (Fractions) 이 객체에는 라벨이 지정된 분수의 시계열이 포함되며, 이러한 값의 합은 항목당 최대 1개입니다. 분수는 소수점 이하 4자리까지 반올림됩니다. 누락된 항목은 모든 분수에서 'NaN''으로 표현됩니다.

구간

bin은 처음부터 끝까지 또는 시작부터 양의 무한대까지 끝이 지정되지 않은 경우 데이터의 개별 부분입니다.

구간의 시작 값과 종료 값은 해당 구간이 나타내는 측정항목의 값 유형으로 제공됩니다. 예를 들어 콘텐츠가 포함된 첫 페인트는 밀리초 단위로 측정되고 int로 노출되므로 측정항목 구간은 시작 및 종료 유형에 int32s를 사용합니다. 그러나 누적 레이아웃 변경은 단위가 없는 십진수로 측정되며 문자열로 인코딩된 십진수로 노출됩니다. 따라서 측정항목 구간은 값 유형에 문자열을 사용합니다.

{
  "start": value,
  "end": value,
  "densities": [number, number, number...etc.]
}

입력란
start	(integer | string) start는 데이터 구간의 시작입니다.
end	(integer | string) end는 데이터 구간의 끝입니다. end가 채워지지 않으면 구간에 끝이 없으며 start부터 +inf까지 유효합니다.
densities	array[number] 지정된 측정항목의 경우 이 구간의 값을 경험한 사용자 비율의 시계열입니다. 밀도는 소수점 이하 4자리까지 반올림됩니다.

백분위수

Percentiles에는 지정된 통계 백분위수에서 측정항목의 합성 값이 포함됩니다. 이 측정항목은 총 사용자 수 중 특정 사용자가 경험하는 측정항목 값을 추정하는 데 사용됩니다.

{
  "P75": value
}

입력란
p75s	array[(integer | string)] 페이지 로드의 75% 에서 이 값보다 작거나 같은 특정 측정항목이 발생한 값의 시계열입니다.

분수

Fractions에는 항목당 합이 최대 1이 되는 라벨이 지정된 분수의 시계열이 포함됩니다. 각 라벨은 어떤 방식으로 페이지 로드를 설명하므로, 이렇게 표현된 측정항목은 숫자 값이 아닌 고유한 값을 생성하는 것으로 생각할 수 있으며, 비율은 특정 고유 값이 측정된 빈도를 나타냅니다.

{
  "label_1": { "fractions": array[fraction]},
  "label_1": { "fractions": array[fraction]},
  ...
  "label_n": { "fractions": array[fraction]}
}

히스토그램 구간의 밀도 값과 마찬가지로 각 fraction는 숫자 0.0 <= value <= 1.0이며 합하면 최대 1.0이 됩니다. 특정 수집 기간에 측정항목을 사용할 수 없는 경우 해당 항목은 모든 분수 배열에서 'NaN'이 됩니다.

입력란
p75s	array[(integer | string)] 페이지 로드의 75% 에서 이 값보다 작거나 낮은 특정 측정항목이 발생한 값의 시계열입니다.

UrlNormalization

조회 성공 가능성을 높이기 위해 URL을 정규화하기 위해 실행한 정규화 작업을 나타내는 객체입니다. 이는 제공된 url_pattern를 조회할 때 실행되는 간단한 자동 변경이며, 이는 실패하는 것으로 알려져 있습니다. 리디렉션과 같은 복잡한 작업은 처리되지 않습니다.

{
  "originalUrl": string,
  "normalizedUrl": string
}

입력란
originalUrl	string 정규화 작업 전에 요청된 원래 URL입니다.
normalizedUrl	string 정규화 작업 이후의 URL입니다. 이 URL은 합리적으로 조회할 수 있는 유효한 사용자 환경 URL입니다.

비율 제한

CrUX History API는 CrUX API와 Google Cloud 프로젝트별 분당 쿼리 150개의 한도를 공유합니다. 두 API는 모두 무료로 제공됩니다. 이 한도와 현재 사용량은 Google Cloud 콘솔에서 확인할 수 있습니다. 이처럼 넉넉한 할당량은 대부분의 사용 사례에 충분하며 증가된 할당량에 대해서는 비용을 지불할 수 없습니다.