إنشاء استعلام مستكشف البيانات باستخدام واجهة برمجة التطبيقات
يشرح هذا الدليل الإرشادي كيفية إنشاء استعلام مستكشف البيانات باستخدام واجهة برمجة تطبيقات Discourse.
مستوى المستخدم المطلوب: مسؤول
المتطلبات الأساسية
قبل البدء، تأكد من توفر ما يلي:
- تثبيت وتفعيل إضافة مستكشف البيانات على موقعك
- مفتاح واجهة برمجة تطبيقات بنطاق عام (Global)، مرتبط بمستخدم مسؤول (راجع إنشاء مفتاح واجهة برمجة تطبيقات وتكوينه)
يتطلب إنشاء الاستعلامات مفتاح واجهة برمجة تطبيقات عام. النطاق التفصيلي “تشغيل الاستعلامات” يسمح فقط بتشغيل الاستعلامات الموجودة، وليس إنشاء استعلامات جديدة.
إنشاء استعلام
لإنشاء استعلام جديد لمستكشف البيانات، أرسل طلب POST إلى /admin/plugins/discourse-data-explorer/queries.
المعلمات
| المعلمة | مطلوب | الوصف |
|---|---|---|
query[name] |
نعم | الاسم الذي ستطلقه على الاستعلام |
query[sql] |
نعم | عبارة SQL المراد تنفيذها |
query[description] |
لا | وصف لما يفعله الاستعلام |
query[group_ids] |
لا | مصفوفة بمعرفات المجموعات التي يمكنها الوصول إلى هذا الاستعلام |
مثال على الطلب
curl -X POST "https://your-site.com/admin/plugins/discourse-data-explorer/queries" \
-H "Content-Type: multipart/form-data;" \
-H "Api-Key: <api-key>" \
-H "Api-Username: <username>" \
-F 'query[name]=User count query' \
-F 'query[sql]=SELECT COUNT(*) FROM users'
مثال على الاستجابة
{
"query": {
"id": 49,
"name": "User count query",
"description": null,
"username": "<username>",
"group_ids": [],
"last_run_at": "2025-03-13T18:41:44.226Z",
"user_id": 1,
"sql": "SELECT COUNT(*) FROM users",
"param_info": [],
"created_at": "2025-03-13T18:41:44.226Z",
"hidden": false
}
}
لاحظ قيمة id في الاستجابة - ستحتاجها لتشغيل الاستعلام. للحصول على تفاصيل حول تشغيل الاستعلامات عبر واجهة برمجة التطبيقات، راجع تشغيل استعلامات مستكشف البيانات باستخدام واجهة برمجة تطبيقات Discourse.