نحوه استفاده از CrUX History API

منتشر شده: ۷ فوریه ۲۰۲۳، آخرین به‌روزرسانی: ۱۱ آوریل ۲۰۲۵

این راهنما، رابط برنامه‌نویسی کاربردی تاریخچه‌ی گزارش تجربه‌ی کاربری کروم (CrUX) را معرفی می‌کند که سری‌های زمانی داده‌های عملکرد وب را ارائه می‌دهد. این داده‌ها به صورت هفتگی به‌روزرسانی می‌شوند و به شما امکان می‌دهند تاریخچه‌ی حدود ۶ ماه را مشاهده کنید، که شامل ۴۰ نقطه داده است که با فاصله‌ی یک هفته از هم قرار گرفته‌اند.

وقتی از به‌روزرسانی‌های روزانه از رابط برنامه‌نویسی کاربردی اصلی CrUX استفاده شود، اکنون می‌توانید به سرعت جدیدترین داده‌ها و آنچه قبلاً اتفاق افتاده است را مشاهده کنید، که این ابزار را به ابزاری قدرتمند برای مشاهده تغییرات صفحه وب در طول زمان تبدیل می‌کند.

API موجود در این صفحه را امتحان کنید

امتحانش کن!

کوئری روزانه از API CrUX

برای خلاصه کردن از مقاله قبلی در مورد API CrUX ، می‌توانید به این روش یک تصویر لحظه‌ای از داده‌های فیلد برای یک مبدا خاص دریافت کنید:

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

این تصویر شامل مقادیر چگالی هیستوگرام و مقادیر صدک برای یک دوره جمع‌آوری ۲۸ روزه خاص، در این مورد، از ۲۷ دسامبر ۲۰۲۲ تا ۲۳ ژانویه ۲۰۲۳ است.

پرس و جو از API تاریخچه CrUX

برای فراخوانی نقطه پایانی history، queryRecord در URL به queryHistoryRecord در دستور curl تغییر دهید. استفاده از همان کلید API CrUX مانند فراخوانی قبلی کار خواهد کرد. collectionPeriodCount تعداد ورودی‌های سری زمانی را که باید بازگردانده شوند مشخص می‌کند؛ حداکثر ۴۰ است. اگر مشخص نشود، به طور پیش‌فرض ۲۵ است.

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}'

شکل کلی یک پاسخ مشابه است، اما داده‌های بسیار بیشتری وجود دارد. به جای یک نقطه داده واحد، اکنون سری‌های زمانی برای فیلدهای حاوی صدک ۷۵ (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