NueForm

واجهة برمجة التحليلات

استرجاع مقاييس الاستجابات وتحليلات الإكمال لنماذجك.

توفر واجهة برمجة التحليلات مقاييس مُجمَّعة حول استجابات النماذج، بما في ذلك الأعداد الإجمالية ومعدلات الإكمال والتفاصيل اليومية.

تستخدم جميع هياكل الاستجابة أسماء حقول بتنسيق snake_case.

لوحة تحليلات النموذج
لوحة التحليلات التي تعرض مقاييس الاستجابات ومعدلات الإكمال.

الحصول على تحليلات النموذج

GET/api/v1/forms/:id/analytics

يُرجع تحليلات الاستجابات لنموذج محدد. يمكنك اختيارياً تصفية النتائج حسب نطاق زمني لتحليل فترات محددة.

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

idstring

معرّف النموذج

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

sincestring

تاريخ بتنسيق ISO 8601. يشمل فقط الاستجابات المُرسلة في هذا التاريخ أو بعده.

untilstring

تاريخ بتنسيق ISO 8601. يشمل فقط الاستجابات المُرسلة في هذا التاريخ أو قبله.

حقول الاستجابة

form_idstring

معرّف النموذج

total_responsesinteger

العدد الإجمالي للإرسالات (بما فيها الجزئية)

completed_responsesinteger

عدد الإرسالات المكتملة بالكامل

completion_ratenumber

نسبة الاستجابات المكتملة (0-100، مُقرَّبة إلى خانتين عشريتين)

average_completion_time_secondsinteger or null

متوسط الوقت بالثواني من أول إجابة حتى الإكمال. null إذا لم تكن هناك استجابات مكتملة.

responses_by_dayarray

تفصيل يومي لأعداد الاستجابات

responses_by_day[].datestring

التاريخ بتنسيق YYYY-MM-DD

responses_by_day[].totalinteger

إجمالي الاستجابات المُرسلة في هذا التاريخ

responses_by_day[].completedinteger

الاستجابات المكتملة في هذا التاريخ

الاستجابة

json
{
  "form_id": "665a1b2c3d4e5f6a7b8c9d0e",
  "total_responses": 342,
  "completed_responses": 298,
  "completion_rate": 87.13,
  "average_completion_time_seconds": 194,
  "responses_by_day": [
    { "date": "2026-02-22", "total": 18, "completed": 16 },
    { "date": "2026-02-23", "total": 24, "completed": 21 },
    { "date": "2026-02-24", "total": 31, "completed": 27 },
    { "date": "2026-02-25", "total": 22, "completed": 20 },
    { "date": "2026-02-26", "total": 28, "completed": 25 },
    { "date": "2026-02-27", "total": 35, "completed": 30 },
    { "date": "2026-02-28", "total": 12, "completed": 11 }
  ]
}

أمثلة على الكود

bash
curl -X GET "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/analytics?since=2026-02-01&until=2026-02-28" \
  -H "Authorization: Bearer YOUR_API_KEY"

نصائح الاستعلام

استخدم معاملات الاستعلام since و until للتحكم في النطاق الزمني للتحليلات.

السجل الكامل

احذف كلاً من since و until للحصول على تحليلات عبر كامل عمر النموذج.

آخر 7 أيام

احسب التاريخ قبل 7 أيام ومرّره كمعامل since للحصول على نافذة أسبوعية متجددة.

شهر محدد

مرّر اليوم الأول والأخير من الشهر كقيم since و until للحصول على تحليلات شهر تقويمي محدد.

السجل الكامل

bash
curl -X GET "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/analytics" \
  -H "Authorization: Bearer YOUR_API_KEY"

آخر 7 أيام

javascript
const since = new Date();
since.setDate(since.getDate() - 7);

const response = await fetch(
  `https://api.nueform.io/api/v1/forms/${formId}/analytics?since=${since.toISOString().split("T")[0]}`,
  { headers: { Authorization: "Bearer YOUR_API_KEY" } }
);

شهر محدد

python
response = requests.get(
    f"https://api.nueform.io/api/v1/forms/{form_id}/analytics",
    params={"since": "2026-01-01", "until": "2026-01-31"},
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)

استجابات الأخطاء

استجابات الأخطاء القياسية التي تُرجعها نقطة النهاية هذه.

رموز الأخطاء

400Bad Request

تنسيق تاريخ غير صالح لـ since أو until

401Unauthorized

مفتاح API مفقود أو غير صالح

403Forbidden

صلاحيات غير كافية لنماذج الفريق

404Not Found

النموذج غير موجود

500Server Error

خطأ داخلي في الخادم

مثال على خطأ

json
{
  "error": "Form not found"
}
آخر تحديث: 6 أبريل 2026