Responses API

फॉर्म रिस्पॉन्स प्राप्त करें, फ़िल्टर करें, हटाएं, और export करें।

Responses API आपको अपने फॉर्म्स द्वारा एकत्र किए गए submissions को प्राप्त करने, फ़िल्टर करने, हटाने, और export करने देता है। सभी रिस्पॉन्स एक विशिष्ट फॉर्म से जुड़े होते हैं।

सभी request और response bodies snake_case फ़ील्ड नामों का उपयोग करते हैं।

Endpoints

GET/api/v1/forms/:id/responsesGET/api/v1/forms/:id/responses/:responseIdDELETE/api/v1/forms/:id/responses/:responseIdPOST/api/v1/forms/:id/responses/bulk-deleteGET/api/v1/forms/:id/responses/export

रिस्पॉन्स की सूची

GET/api/v1/forms/:id/responses

किसी फॉर्म के रिस्पॉन्स की paginated सूची लौटाता है, सबमिशन तिथि के अनुसार क्रमबद्ध (सबसे हालिया पहले)।

Path Parameters

idstringआवश्यक

फॉर्म ID

Query Parameters

pageinteger

पेज नंबर (डिफ़ॉल्ट: 1)

per_pageinteger

प्रति पेज परिणाम (डिफ़ॉल्ट: 50)

sincestring

ISO 8601 तिथि। केवल इस तिथि पर या उसके बाद सबमिट किए गए रिस्पॉन्स लौटाएं।

untilstring

ISO 8601 तिथि। केवल इस तिथि पर या उससे पहले सबमिट किए गए रिस्पॉन्स लौटाएं।

completedboolean

completion स्थिति के अनुसार फ़िल्टर करें। true केवल पूर्ण रिस्पॉन्स लौटाता है, false केवल आंशिक रिस्पॉन्स लौटाता है।

Answer Value Types

short_textstring

उदाहरण: "Jane Smith"

long_textstring

उदाहरण: "I really enjoyed the product..."

multiple_choicestring

उदाहरण: "Option A"

multiple_choice (multi)array of strings

उदाहरण: ["Option A", "Option C"]

ratingnumber

उदाहरण: 4

opinion_scalenumber

उदाहरण: 8

numbernumber

उदाहरण: 42

emailstring

उदाहरण: "jane@example.com"

datestring (ISO 8601)

उदाहरण: "2026-03-15"

yes_noboolean

उदाहरण: true

file_uploadobject

उदाहरण: { "url": "...", "name": "doc.pdf" }

dropdownstring

उदाहरण: "United States"

Response

json

{
  "responses": [
    {
      "id": "667a1b2c3d4e5f6a7b8c9d01",
      "form_id": "665a1b2c3d4e5f6a7b8c9d0e",
      "visitor_id": "v_8f2k3j4l5m6n",
      "submitted_at": "2026-02-27T15:42:00.000Z",
      "completed_at": "2026-02-27T15:45:30.000Z",
      "metadata": {
        "user_agent": "Mozilla/5.0",
        "referrer": "https://example.com"
      },
      "answers": [
        {
          "question_id": "66a1b2c3d4e5f6a7b8c9d001",
          "value": "Jane Smith"
        },
        {
          "question_id": "66a1b2c3d4e5f6a7b8c9d002",
          "value": "Social media"
        },
        {
          "question_id": "66a1b2c3d4e5f6a7b8c9d003",
          "value": 5
        }
      ],
      "quiz_results": null
    }
  ],
  "total": 142,
  "page": 1,
  "per_page": 50
}

कोड उदाहरण

bash

curl -X GET "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/responses?page=1&per_page=25&completed=true" \
  -H "Authorization: Bearer YOUR_API_KEY"

रिस्पॉन्स प्राप्त करें

GET/api/v1/forms/:id/responses/:responseId

ID द्वारा एक रिस्पॉन्स प्राप्त करता है।

Path Parameters

idstringआवश्यक

फॉर्म ID

responseIdstringआवश्यक

रिस्पॉन्स ID

क्विज़ परिणाम

क्विज़ मोड (knowledge_quiz, lead_qualification, match_quiz) का उपयोग करने वाले फॉर्म्स के लिए, quiz_results फ़ील्ड में स्कोरिंग डेटा होता है।

Response

json

{
  "id": "667a1b2c3d4e5f6a7b8c9d01",
  "form_id": "665a1b2c3d4e5f6a7b8c9d0e",
  "visitor_id": "v_8f2k3j4l5m6n",
  "submitted_at": "2026-02-27T15:42:00.000Z",
  "completed_at": "2026-02-27T15:45:30.000Z",
  "metadata": {
    "user_agent": "Mozilla/5.0",
    "referrer": "https://example.com"
  },
  "answers": [
    {
      "question_id": "66a1b2c3d4e5f6a7b8c9d001",
      "value": "Jane Smith"
    },
    {
      "question_id": "66a1b2c3d4e5f6a7b8c9d002",
      "value": "Social media"
    },
    {
      "question_id": "66a1b2c3d4e5f6a7b8c9d003",
      "value": 5
    }
  ],
  "quiz_results": null
}

क्विज़ परिणाम उदाहरण

json

{
  "quiz_results": {
    "score": 8,
    "correct_answers": 4,
    "total_scorable_questions": 5,
    "max_score": 10,
    "matched_ending_id": null,
    "form_mode": "knowledge_quiz"
  }
}

कोड उदाहरण

bash

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

रिस्पॉन्स हटाएं

DELETE/api/v1/forms/:id/responses/:responseId

एक रिस्पॉन्स को स्थायी रूप से हटाता है।

यह क्रिया अपरिवर्तनीय है। हटाने के बाद रिस्पॉन्स डेटा पुनर्प्राप्त नहीं किया जा सकता।

Path Parameters

idstringआवश्यक

फॉर्म ID

responseIdstringआवश्यक

रिस्पॉन्स ID

Response

json

{
  "success": true
}

कोड उदाहरण

bash

curl -X DELETE "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/responses/667a1b2c3d4e5f6a7b8c9d01" \
  -H "Authorization: Bearer YOUR_API_KEY"

बल्क रिस्पॉन्स हटाएं

POST/api/v1/forms/:id/responses/bulk-delete

एक ही request में कई रिस्पॉन्स हटाता है। प्रति request अधिकतम 100 रिस्पॉन्स। सभी निर्दिष्ट response IDs दिए गए फॉर्म से संबंधित होने चाहिए।

Path Parameters

idstringआवश्यक

फॉर्म ID

Request Body

response_idsarray of stringsआवश्यक

हटाने के लिए रिस्पॉन्स IDs (अधिकतम 100)

Request उदाहरण

json

{
  "response_ids": [
    "667a1b2c3d4e5f6a7b8c9d01",
    "667a1b2c3d4e5f6a7b8c9d02",
    "667a1b2c3d4e5f6a7b8c9d03"
  ]
}

Response

json

{
  "deleted": 3
}

कोड उदाहरण

bash

curl -X POST "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/responses/bulk-delete" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "response_ids": [
      "667a1b2c3d4e5f6a7b8c9d01",
      "667a1b2c3d4e5f6a7b8c9d02"
    ]
  }'

किसी फॉर्म के सभी रिस्पॉन्स को CSV फ़ाइल के रूप में export करता है। CSV में responseId, submittedAt, completedAt, और प्रति प्रश्न एक column (प्रश्न शीर्षक को column header के रूप में उपयोग करते हुए) शामिल होते हैं।

Group प्रश्नों (question_group, multi_question_page, contact_info, address) के लिए, प्रत्येक sub-field को अपना अलग column मिलता है।

Path Parameters

idstringआवश्यक

फॉर्म ID

Response

Content-Type: text/csv के साथ एक CSV फ़ाइल लौटाता है।

text

responseId,submittedAt,completedAt,What is your name?,How did you hear about us?,How would you rate your overall experience?
667a1b2c3d4e5f6a7b8c9d01,2026-02-27T15:42:00.000Z,2026-02-27T15:45:30.000Z,Jane Smith,Social media,5
667a1b2c3d4e5f6a7b8c9d02,2026-02-26T10:15:00.000Z,2026-02-26T10:18:22.000Z,Bob Johnson,Search engine,4
667a1b2c3d4e5f6a7b8c9d03,2026-02-25T08:30:00.000Z,,Alex Chen,Friend or colleague,

कोड उदाहरण

bash

curl -X GET "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/responses/export" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o responses.csv

Error Responses

सभी endpoints मानक error responses लौटाते हैं:

Status Codes

400Bad Request

अमान्य parameters, बल्क delete 100 आइटम से अधिक

401Unauthorized

API key गायब या अमान्य है

403Forbidden

अपर्याप्त टीम अनुमतियां

404Not Found

फॉर्म या रिस्पॉन्स नहीं मिला

500Internal Server Error

Internal server error

Error उदाहरण

json

{
  "error": "Response not found"
}

अंतिम अपडेट: 6 अप्रैल 2026