الانتقال إلى المحتوى الرئيسي
GetQR API في مرحلة تجريبية (beta) ومتاحة لمساحات عمل مختارة. قد تتغير التفاصيل قبل الإصدار العام.
احصل على إجماليات المسح وتصنيفاتها حسب الدولة والجهاز والمتصفح وغير ذلك، لرمز QR واحد أو على مستوى مساحة عملك. للحصول على ملخص جاهز لكل رمز QR، راجع التقارير.

معنى الأرقام

  • عمليات المسح. كل عدد موجود في الحقل clicks. تُحتسب عملية مسح في كل مرة يفتح فيها شخص الرابط القصير لرمز QR.
  • عمليات المسح الفريدة. مع unique=true، يُحتسب كل زائر مرة واحدة ضمن النطاق الزمني.
  • النطاق. تأتي الأرقام من الرابط القصير لرمز QR. رمز QR الذي لا رابط قصيرًا له ليست لديه عمليات مسح تُحتسب.
  • السجل. لا يمكن إعادة تعيين التحليلات عبر API. حذف رمز QR لا يمسح بيانات المسح التاريخية الخاصة به.

الترويسات

string
مطلوب
Bearer متبوعة بمفتاح API الخاص بك. راجع المصادقة.

معاملات الاستعلام

تأخذ نقطتا النهاية كلتاهما هذه المعاملات. جميعها اختيارية.
string
افتراضي:"count"
بُعد التصنيف. تُرجع count الإجمالي. راجع التصنيفات لكل قيمة وبنية استجابتها.
string
افتراضي:"30d"
نطاق زمني جاهز: 24h أو 7d أو 30d أو 90d أو 1y أو mtd أو qtd أو ytd أو all. راجع النطاقات الزمنية. يُتجاهل عند إرسال start.
string
بداية نطاق مخصص، بصيغة ISO 8601، مثل 2026-08-01 أو 2026-08-01T00:00:00Z. له الأولوية على interval. يجب أن يكون قبل end.
string
نهاية نطاق مخصص، بصيغة ISO 8601. القيمة الافتراضية نهاية اليوم. يُستخدم مع start أو interval=all، ويُتجاهل مع النطاقات الأخرى.
string
افتراضي:"UTC"
المنطقة الزمنية بصيغة IANA المستخدمة لمحاذاة فترات timeseries، مثل America/New_York. تُرجع المنطقة الزمنية غير المعروفة 422.
boolean
افتراضي:"false"
true تحتسب عمليات المسح الفريدة بدلًا من إجمالي عمليات المسح.
يمكنك أيضًا إرسال مرشحات الأبعاد.

النطاقات الزمنية

لنطاق مخصص، أرسل start وend اختياريًا. تستخدم النطاقات حتى يومين فترات بالساعة، والنطاقات التي تتجاوز 180 يومًا فترات شهرية، وكل ما بينهما فترات يومية.

مرشحات الأبعاد

اقصر النتائج على عمليات المسح المطابقة لمرشح. تُجمع المرشحات المختلفة بـ AND. وعندما يأخذ مرشح عدة قيم، افصل بينها بفواصل: تُجمع القيم بـ OR. يُرجع رمز الدولة أو القارة غير المعروف 422. تُطابَق أسماء الأجهزة والمتصفحات وأنظمة التشغيل بحرف أول كبير، لذا تعمل mobile مثل Mobile. على سبيل المثال، عمليات المسح من الولايات المتحدة أو كندا على الأجهزة المحمولة: ?country=US,CA&device=Mobile.

التصنيفات

تُرجع count كائنًا. وتُرجع كل قيمة أخرى مصفوفة مرتبة حسب clicks من الأعلى إلى الأدنى (تُرتَّب timeseries حسب الوقت). تُرجع قيمة groupBy غير المعروفة 422 مع قائمة القيم الصالحة. الاستجابة عند groupBy=count:
الاستجابة عند groupBy=countries:

الحصول على تحليلات رمز QR

GET /api/v1/qrs/{qrId}/analytics يُرجع إحصائيات المسح لرمز QR واحد، مقصورة على رابطه القصير. يأخذ معاملات الاستعلام ومرشحات الأبعاد المذكورة أعلاه.
string
مطلوب
معرّف رمز QR. خذه من استجابة القائمة أو الإنشاء في رموز QR.

الحصول على تحليلات مساحة العمل

GET /api/v1/analytics يُرجع إحصائيات المسح لجميع رموز QR في مساحة عملك. يأخذ معاملات الاستعلام ومرشحات الأبعاد المذكورة أعلاه، إضافةً إلى معاملات النطاق التالية.
string
مع key، يقصر النتائج على الرابط القصير الذي يحمل هذا النطاق، مثل getqr.sh. يجب أن ينتمي النطاق إلى مساحة عملك.
string
المعرّف النصي (slug) للرابط القصير، مثل x7Kd2p1. استخدمه مع domain. كلاهما موجود في كائن رمز QR.
string
أنواع رموز QR المراد تضمينها، مفصولة بفواصل: website أو pdf أو image أو video أو whatsapp أو social أو wifi أو app أو feedback أو vcard أو sms أو payment أو location أو multilink أو email أو event. راجع أنواع QR.

المشكلات الشائعة

لا يوجد في مساحة عملك رابط قصير بهذا النطاق والمعرّف النصي. انسخ domain وkey من كائن رمز QR.
القيمة غير مدعومة. تذكر رسالة الخطأ اسم المعامل وتسرد القيم الصالحة.
تحقّق من أنك تستخدم النطاق الزمني والمنطقة الزمنية نفسيهما، ومما إذا كنت تحتسب عمليات المسح الفريدة (unique=true) أم إجمالي عمليات المسح.

الخطوات التالية

التقارير

رموز QR

التحليلات في التطبيق

حدود الطلبات