curl --request POST \
--url 'https://api.scanova.io/analytics/report/' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"filter_type": "qrcode",
"filter_data": "[\"Q07afe81aa0034c01\"]",
"start_date": "2026-08-01",
"end_date": "2026-08-31",
"report_type": "both",
"analytics_format": "xlsx",
"scan_format": "csv"
}'
{
"id": 59,
"filter_type": "qrcode",
"filter_data": "[\"Q07afe81aa0034c01\"]",
"start_date": "2026-08-01",
"end_date": "2026-08-31",
"report_type": "both",
"analytics_format": "xlsx",
"scan_format": "csv",
"status": "new",
"report_file": null,
"completed_on": null,
"is_saved": false,
"saved_name": null,
"created": "2026-09-08T10:20:00Z",
"requested_by_name": "Docs"
}
التحليلات والخطط
تشغيل إنشاء تقرير تحليلات
POST /analytics/report/
POST
/
analytics
/
report
/
curl --request POST \
--url 'https://api.scanova.io/analytics/report/' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"filter_type": "qrcode",
"filter_data": "[\"Q07afe81aa0034c01\"]",
"start_date": "2026-08-01",
"end_date": "2026-08-31",
"report_type": "both",
"analytics_format": "xlsx",
"scan_format": "csv"
}'
{
"id": 59,
"filter_type": "qrcode",
"filter_data": "[\"Q07afe81aa0034c01\"]",
"start_date": "2026-08-01",
"end_date": "2026-08-31",
"report_type": "both",
"analytics_format": "xlsx",
"scan_format": "csv",
"status": "new",
"report_file": null,
"completed_on": null,
"is_saved": false,
"saved_name": null,
"created": "2026-09-08T10:20:00Z",
"requested_by_name": "Docs"
}
يضع في قائمة الانتظار مهمة غير متزامنة تُنشئ تقرير بيانات مسح و/أو تحليلات يغطي مجموعة من رموز QR أو وسمًا أو مجلدًا.
يُعيد الاستدعاء
يتطلب مفتاح واجهة برمجة تطبيقات إدارة بحصة
MANAGEMENT_API (أو MANAGEMENT_API_SANDBOX) — راجع نظرة عامة على واجهة برمجة التطبيقات للإدارة — بالإضافة إلى حصة EXPORT_ANALYTICS_REPORT وصلاحية ANALYTICS_CAN_EXPORT_REPORT الخاصتين بالحساب.string
مطلوب
ما الذي تحدده
filter_data: qrcode أو tag أو folder.string
مطلوب
سلسلة مُرمَّزة بصيغة JSON تحدد الهدف (الأهداف) — مثل مصفوفة JSON من
qrids عندما تكون filter_type هي qrcode.string
مطلوب
تاريخ البدء (
YYYY-MM-DD).string
مطلوب
تاريخ الانتهاء (
YYYY-MM-DD).string
افتراضي:"both"
scan_data أو analytics أو both.string
افتراضي:"csv"
تنسيق الملف لجزء التحليلات:
csv أو xls أو xlsx أو png أو jpeg أو pdf.string
افتراضي:"csv"
تنسيق الملف لجزء بيانات المسح: نفس خيارات
analytics_format.object
حمولة تصفية JSON إضافية اختيارية، تُوضع فوق
filter_type/filter_data.boolean
افتراضي:"false"
يستبعد عمليات المسح المحددة كحركة روبوتات من التقرير.
boolean
افتراضي:"false"
ما إذا كان يجب الاحتفاظ بهذا التقرير كإعداد مسبق محفوظ قابل لإعادة الاستخدام — راجع تحديث تقرير تحليلات محفوظ.
string
اسم للإعداد المسبق المحفوظ، مطلوب إذا كانت
is_saved بقيمة true. يجب أن يكون فريدًا لكل حساب — تكراره يُعيد 400.curl --request POST \
--url 'https://api.scanova.io/analytics/report/' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"filter_type": "qrcode",
"filter_data": "[\"Q07afe81aa0034c01\"]",
"start_date": "2026-08-01",
"end_date": "2026-08-31",
"report_type": "both",
"analytics_format": "xlsx",
"scan_format": "csv"
}'
{
"id": 59,
"filter_type": "qrcode",
"filter_data": "[\"Q07afe81aa0034c01\"]",
"start_date": "2026-08-01",
"end_date": "2026-08-31",
"report_type": "both",
"analytics_format": "xlsx",
"scan_format": "csv",
"status": "new",
"report_file": null,
"completed_on": null,
"is_saved": false,
"saved_name": null,
"created": "2026-09-08T10:20:00Z",
"requested_by_name": "Docs"
}
201 فورًا بمجرد وضع المهمة في قائمة الانتظار، مع status: "new" — يُنشأ التقرير نفسه في الخلفية، ويتلقى الحساب بريدًا إلكترونيًا عند الاكتمال. استعلِم عن سرد تقارير التحليلات لمعرفة status وreport_file.
ذو صلة
- سرد تقارير التحليلات — الاستعلام عن حالة المهمة.
- تحديث تقرير تحليلات محفوظ — إعادة تسمية أو إدارة إعداد مسبق محفوظ.
- نظرة عامة على واجهة برمجة التطبيقات للإدارة — مخطط المصادقة وبنية الحصص التي ينتمي إليها هذا الطرف.
التفويضات
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. api.scanova.io) — the same key sent to the regular API host will not authenticate.
الاستجابة
201 - application/json
Report job queued.
هل كانت هذه الصفحة مفيدة؟