Skip to main content
POST
يعيد تحليلات المسح المجمّعة لرمز QR واحد أو أكثر، مصنّفة بحسب نوع (أو أنواع) المقياس الذي تطلبه.
هذه نقطة نهاية POST فقط رغم أن الاسم يوحي بعملية بحث — طلب GET يعيد 405 Method Not Allowed. معلمات الاستعلام (from، to، type) تحدد النطاق الزمني والمقاييس؛ نص الطلب يحدد رموز QR المطلوب تضمينها.
يتطلب مفتاح Management API بحصة MANAGEMENT_API (أو MANAGEMENT_API_SANDBOX) — راجع نظرة عامة على Management API — بالإضافة إلى حصة QR_ANALYTICS_BASIC الخاصة بالحساب نفسه. طلب أي شيء يتجاوز مقياس count يتطلب إضافيًا QR_ANALYTICS_ADVANCED؛ من دونها، يُخفَّض كل طلب بصمت إلى count بغض النظر عن type الذي طلبته.

الطلب

تم التحقق منه مباشرة على النظام الفعلي — مصفوفة qr الفارغة هنا تعكس رمز QR بلا أي عمليات مسح ضمن النافذة الزمنية المطلوبة، وليست خطأً. qr_meta هي خريطة إضافية من name -> {qrid, category, category_slug}، تُضاف فقط عندما تكون qr ضمن type المطلوبة، بحيث يمكن للمستدعي الربط من صف مفهرَس بالاسم رجوعًا إلى qrid الخاص به. إنها إضافية بحتة: الشكل الذي يحلّله المستدعون بالفعل تحت كل مفتاح مقياس يبقى دون تغيير.

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

string
مطلوب
تاريخ البدء (YYYY-MM-DD)، شامل.
string
مطلوب
تاريخ الانتهاء (YYYY-MM-DD)، شامل.
string
مطلوب
أنواع مقاييس مفصولة بفواصل، مثل qr,device,geography. القيم الشائعة: count، qr، date، day، time، utm، device، os، browser، handset، geography، geo_location، age. يتطلب حصة QR_ANALYTICS_ADVANCED الخاصة بالحساب لأي شيء يتجاوز count.
string
افتراضي:"date"
التجميع لأنواع المقاييس الزمنية المتسلسلة، مثل date، week، month.
boolean
افتراضي:"false"
يستبعد عمليات المسح المحدَّدة كحركة روبوتات (bot) من النتائج.
boolean
مرِّر true للاستدعاءات على غرار نظرة عامة على لوحة التحكم — يتجاوز حد حجم عدد رموز QR/النطاق الزمني الموصوف أدناه، ولا يُحتسب ضمن مؤشر نشاط “التحليلات المسحوبة” الخاص بالحساب.

نص الطلب

array
مطلوب
قائمة المعرّفات التي تُحدَّد التحليلات ضمن نطاقها — نوع المعرّف يعتمد على filter_by.
string
افتراضي:"qrid"
واحد من qrid (معرّفات رموز QR)، id (المعرّفات الرقمية الداخلية)، tags (أسماء الوسوم)، أو folder (معرّفات المجلدات).

الاستجابة

الاستجابة كائن مفهرس بكل type مقياس مطلوب، بالإضافة إلى qr_meta عند الاقتضاء (انظر أعلاه). يختلف الشكل حسب نوع المقياس — count يعيد إجماليات المسح، وdevice/os/browser/geography تعيد تفصيلات حسب ذلك البُعد، وأنواع السلاسل الزمنية (date/day/time) تعيد سلسلة مقسّمة حسب group.
طلب عدد كبير جدًا من رموز QR ضمن نطاق زمني واسع جدًا يعيد 400 تحت q: "High Volume of data. Either select lower than {N} QR Codes/{N} days time period or generate Analytics Export instead." عمليًا، كل من تصدير التحليلات وتصدير التحليلات الخام يفرضان الحد نفسه بالضبط — نقاط النهاية الثلاث جميعها تتشارك مسار كود التحقق من صحة الطلب نفسه — لذا الحل الفعلي لهذا الخطأ هو تضييق q أو النطاق الزمني، لا التبديل بين نقاط النهاية.

ذات صلة

التفويضات

Authorization
string
header
مطلوب

Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: 401f7ac837da42b97f613d789819ff93537bee6a. A header containing more than one space-separated part is rejected outright. Requests also require the request's Host header to be the management API host (e.g. management.scanova.io) — the same key sent to the regular API host will not authenticate.

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

from
string<date>
مطلوب
to
string<date>
مطلوب
type
string
مطلوب

Comma-separated metric types, e.g. qr.

group
string
افتراضي:date

Grouping for time-series metric types, e.g. date/week/month.

exclude_bot_scan
boolean
افتراضي:false
overview
boolean

Bypasses the volume cap; used by dashboard overview widgets.

الجسم

application/json
q
string[]
مطلوب

Query data — a list of identifiers of the type named in filter_by.

filter_by
enum<string>
افتراضي:qrid
الخيارات المتاحة:
qrid,
tags,
id,
folder

الاستجابة

200 - application/json

Analytics data, grouped by the requested type(s). A qr_meta name->{qrid, category, category_slug} map is attached whenever qr is among the requested types.