איך משתמשים ב-CrUX History API

Johannes Henkel
Johannes Henkel
X GitHub Mastodon
Jasmine Yan
Jasmine Yan
GitHub
Barry Pollard

פורסם: 7 בפברואר 2023, עדכון אחרון: 11 באפריל 2025

במדריך הזה מוצגת נקודת הקצה Chrome UX Report (CrUX) History API, שמספקת נתונים של ביצועי אתרים על ציר הזמן. הנתונים האלה מתעדכנים מדי שבוע, ואפשר לראות היסטוריה של כ-6 חודשים, עם 40 נקודות נתונים במרווחים של שבוע.

כשמשתמשים בנקודת הקצה החדשה של 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 ימים, במקרה הזה, מ-27 בדצמבר 2022 עד 23 בינואר 2023.

שאילתות ב-CrUX History API

כדי לקרוא לנקודת הקצה של ההיסטוריה, משנים את queryRecord בכתובת ה-URL ל-queryHistoryRecord בפקודה curl. אפשר להשתמש באותו מפתח CrUX API כמו בקריאה הקודמת. ‫collectionPeriodCount מציין את מספר הרשומות של סדרות הזמן שיוחזרו. המספר המקסימלי הוא 40. אם לא מציינים ערך, ברירת המחדל היא 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}'

התשובה דומה, אבל יש בה הרבה יותר נתונים. במקום נקודת נתונים אחת, יש עכשיו סדרות זמן לשדות שמכילים את האחוזון ה-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
            ]
          },  {