مرجع API
مؤشرات الويب الحيوية
نقطة النهاية POST /api/v1/vitals
يرسل SDK المتصفح هذا الإشارة؛ الصيغة ثابتة وصغيرة لتُرسل عبر sendBeacon كـ text/plain بدون فحص CORS مسبق.
1الطلب
المفتاح في ?key= أو X-Blipit-Key، والنسخة اختيارية. الجسم حتى 4 كيلوبايت، JSON كـ application/json أو text/plain: path (من 1 إلى 512 حرفًا، يبدأ بـ /، بدون ? أو # أو مسافات)، وmetrics {lcp, inp, cls, fcp, ttfb} (محدودة، من 0 إلى 120 ث؛ INP حتى 60 ث؛ CLS حتى 100؛ أي مجموعة فرعية)، وnav (نوع التنقل؛ route لتغيير مسار في تطبيق صفحة واحدة)، وconnection وdevice (الأنواع المعروفة فقط).
navigator.sendBeacon(
"https://in.blipit.io/api/v1/vitals?key=<public key>",
JSON.stringify({ path: "/checkout", metrics: { lcp: 1840, cls: 0.03, ttfb: 320 }, nav: "navigate", device: "mobile", connection: "4g" })
);2الاستجابات
202 {ok: true}، أو 202 {ok: true, skipped: 'bot'} لوكلاء مستخدم الروبوتات. 400 لأي شيء خارج الشكل. 401 أو 403 لمشكلات المفتاح.
من المفيد معرفته
- 1,200 طلب في الدقيقة لكل مفتاح.
- يُحتفظ بالعينات لمدة 30 يومًا.
- لا تضع سلسلة الاستعلام في path؛ يرفضها الاستقبال.
- 409 عندما تأتي البيانات من منصة غير منصة المشروع، مثلًا {"error": "This project is for iOS. Create a separate Android project in Blipit and use its key.", "reason": "platform_mismatch", "project_platform": "ios", "sent_platform": "android"}. تجيب الأحداث والجلسات والسجلات وتتبعات ومقاييس OTLP وتقارير الأخطاء وتسجيلات الجلسات وweb vitals كلها بهذه الطريقة. البيانات المرفوضة لا تُحفظ ولا تُحسب من الحصة. تسجّل حزم Blipit SDK هذا الخطأ مرة واحدة وتتوقف عن الإرسال لبقية التشغيل. للإصلاح، أنشئ مشروعًا لتلك المنصة واستخدم مفتاحه.
هل واجهتك مشكلة؟ راسل support@blipit.io. المفاتيح ومعرّف كل مشروع موجودة تحت مفاتيح API في app.blipit.io.