API التقديمات
أنشئ واسترجع تقديمات التغذية الراجعة برمجياً.
قائمة التقديمات
GET /api/v2/submissions
معاملات الاستعلام
| المعامل | النوع | الوصف |
|---|---|---|
page | integer | رقم الصفحة (الافتراضي: 1) |
per_page | integer | العناصر في الصفحة (الافتراضي: 15، الحد الأقصى: 100) |
status | string | تصفية حسب الحالة: pending، approved، resolved، spam |
campaign_id | integer | تصفية حسب معرف الحملة |
product_id | integer | تصفية حسب معرف المنتج |
from | date | تاريخ البدء (YYYY-MM-DD) |
to | date | تاريخ الانتهاء (YYYY-MM-DD) |
مثال
curl "https://yourdomain.com/api/v2/submissions?status=approved&per_page=10" \
-H "Authorization: Bearer YOUR_API_KEY"
الاستجابة
{
"data": [
{
"id": 42,
"campaign_id": 1,
"product_id": 1,
"star_rating": 5,
"nps_score": 9,
"text_feedback": "Absolutely love this product!",
"customer_name": "Jane Doe",
"customer_email": "[email protected]",
"sentiment_score": 0.92,
"sentiment_label": "positive",
"status": "approved",
"is_public": true,
"admin_reply": "Thank you, Jane! We're glad you love it.",
"created_at": "2024-03-15T10:30:00Z"
}
],
"meta": {
"current_page": 1,
"per_page": 10,
"total": 42
}
}
الحصول على تقديم محدد
GET /api/v2/submissions/{id}
مثال
curl "https://yourdomain.com/api/v2/submissions/42" \
-H "Authorization: Bearer YOUR_API_KEY"
إنشاء تقديم
POST /api/v2/submissions
جسم الطلب
{
"campaign_id": 1,
"star_rating": 5,
"nps_score": 9,
"text_feedback": "Great product, very intuitive!",
"customer_name": "John Smith",
"customer_email": "[email protected]"
}
المعاملات
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
campaign_id | integer | نعم | الحملة المراد التقديم إليها |
star_rating | integer | لا | تقييم بالنجوم من 1-5 |
nps_score | integer | لا | درجة NPS من 0-10 |
text_feedback | string | لا | تغذية راجعة بنص حر |
customer_name | string | لا | اسم المُقدِّم |
customer_email | string | لا | بريد المُقدِّم الإلكتروني |
survey_responses | object | لا | إجابات حقول الاستطلاع المخصصة |
الاستجابة (201 Created)
{
"data": {
"id": 43,
"campaign_id": 1,
"star_rating": 5,
"status": "pending",
"created_at": "2024-03-15T11:00:00Z"
},
"message": "Submission created successfully"
}