Post /surveys/{{survey-id}}/responses

Example Request

https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/responses

The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.


Authorization

arrow_rightSecurity - API Key
Name : api-key
required
Location : Request Header
Type : string

Request Parameters

arrow_rightPath Parameters
survey-id integer
required

Request Body

arrow_rightPayload- Mandatory Parameters
Snippet copied successfully.
application/json
{
        "responseSet": [
            {
                "questionID": 12345678,
                "answerValues": [
                    {
                        "answerID": 123456789
                        }
                ]
            },
            {
                "questionID": 12345679,
                "answerValues": [
                    {
                        "answerID": 100000001,
                        "value": {
                            "text": "FirstName"
                        }
                    }
                ]
            },
            {
                "questionID": 83734737,
                "answerValues": [
                    {
                        "answerID": 100000002,
                        "value": {
                            "text": "LastName"
                        }
                    }
                ]
            },
            {
                "questionID": 83734738,
                "answerValues": [
                    {
                        "answerID": 100000003,
                        "value": {
                           "text": "123-456-7890"
                        }
                    }
                ]
            },
            {
                "questionID": 83734739,
                "answerValues": [
                    {
                        "answerID": 100000004,
                        "value": {
                            "text": "respondentemail@emaildomain.com"
                        }
                    }
                ]
            }
        ]
}
arrow_rightPayload- All Parameters
application/json
{
        "ipAddress": "192.168.0.1",
        "timestamp": "05 Oct, 2020 02:51:51 PM PDT",
        "location": {
            "country": null,
            "region": "16",
            "latitude": 0.0,
            "longitude": 0.0,
            "radius": 0.0,
            "countryCode": "IN"
        },
        "duplicate": false,
        "timeTaken": 41,
        "responseStatus": "Completed",
        "externalReference": "",
        "customVariables": {
            "custom1": null,
            "custom2": null,
            "custom3": null,
            "custom4": null,
            "custom5": null
        },
        "language": "English",
        "currentInset": "",
        "operatingSystem": "WINDOWS_10",
        "osDeviceType": "COMPUTER",
        "browser": "CHROME8",
        "responseSet": [
            {
                "questionID": 12345678,
                "questionDescription": " ",
                "questionCode": "Q1",
                "questionText": "How often do you conduct surveys?",
                "imageUrl": null,
                "answerValues": [
                    {
                        "answerID": 123456789,
                        "answerText": "Always",
                        "value": {
                            "scale": "1",
                            "other": "",
                            "dynamicExplodeText": "",
                            "text": "",
                            "result": "",
                            "fileLink": "",
                            "weight": 0.0
                        }
                    }
                ]
            },
            {
                "questionID": 12345679,
                "questionDescription": "Contact Information",
                "questionCode": "Q2_1",
                "questionText": "First Name",
                "imageUrl": null,
                "answerValues": [
                    {
                        "answerID": 100000001,
                        "answerText": "FIRST_NAME",
                        "value": {
                            "scale": "",
                            "other": "",
                            "dynamicExplodeText": "",
                            "text": "FirstName",
                            "result": "",
                            "fileLink": "",
                            "weight": 0.0
                        }
                    }
                ]
            },
            {
                "questionID": 83734737,
                "questionDescription": " ",
                "questionCode": "Q2_2",
                "questionText": "Last Name",
                "imageUrl": null,
                "answerValues": [
                    {
                        "answerID": 100000002,
                        "answerText": "LAST_NAME",
                        "value": {
                            "scale": "",
                            "other": "",
                            "dynamicExplodeText": "",
                            "text": "LastName",
                            "result": "",
                            "fileLink": "",
                            "weight": 0.0
                        }
                    }
                ]
            },
            {
                "questionID": 83734738,
                "questionDescription": " ",
                "questionCode": "Q2_3",
                "questionText": "Phone",
                "imageUrl": null,
                "answerValues": [
                    {
                        "answerID": 100000003,
                        "answerText": "PHONE",
                        "value": {
                            "scale": "",
                            "other": "",
                            "dynamicExplodeText": "",
                            "text": "123-456-7890",
                            "result": "",
                            "fileLink": "",
                            "weight": 0.0
                        }
                    }
                ]
            },
            {
                "questionID": 83734739,
                "questionDescription": " ",
                "questionCode": "Q2_4",
                "questionText": "Email Address",
                "imageUrl": null,
                "answerValues": [
                    {
                        "answerID": 100000004,
                        "answerText": "EMAIL",
                        "value": {
                            "scale": "",
                            "other": "",
                            "dynamicExplodeText": "",
                            "text": "respondentemail@emaildomain.com",
                            "result": "",
                            "fileLink": "",
                            "weight": 0.0
                        }
                    }
                ]
            }
        ]
}

Example Code

arrow_rightcURL
Snippet copied successfully.
application/json
curl --location 'https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/responses' \
--header 'Content-Type: application/json' \
--header 'api-key: {{api-key}}' \
--data-raw '{
    "responseSet": [
        {
            "questionID": 12345678,
            "answerValues": [
                {
                    "answerID": 123456789
                }
            ]
        },
        {
            "questionID": 12345679,
            "answerValues": [
                {
                    "answerID": 100000001,
                    "value": {
                        "text": "FirstName"
                    }
                }
            ]
        },
        {
            "questionID": 83734737,
            "answerValues": [
                {
                    "answerID": 100000002,
                    "value": {
                        "text": "LastName"
                    }
                }
            ]
        },
        {
            "questionID": 83734738,
            "answerValues": [
                {
                    "answerID": 100000003,
                    "value": {
                        "text": "123-456-7890"
                    }
                }
            ]
        },
        {
            "questionID": 83734739,
            "answerValues": [
                {
                    "answerID": 100000004,
                    "value": {
                        "text": "respondentemail@emaildomain.com"
                    }
                }
            ]
        }
    ]
}'
arrow_rightPython
Snippet copied successfully.
application/json
import requests
import json

url = "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/responses"

payload = json.dumps({
  "responseSet": [
    {
      "questionID": 12345678,
      "answerValues": [
        {
          "answerID": 123456789
        }
      ]
    },
    {
      "questionID": 12345679,
      "answerValues": [
        {
          "answerID": 100000001,
          "value": {
            "text": "FirstName"
          }
        }
      ]
    },
    {
      "questionID": 83734737,
      "answerValues": [
        {
          "answerID": 100000002,
          "value": {
            "text": "LastName"
          }
        }
      ]
    },
    {
      "questionID": 83734738,
      "answerValues": [
        {
          "answerID": 100000003,
          "value": {
            "text": "123-456-7890"
          }
        }
      ]
    },
    {
      "questionID": 83734739,
      "answerValues": [
        {
          "answerID": 100000004,
          "value": {
            "text": "respondentemail@emaildomain.com"
          }
        }
      ]
    }
  ]
})
headers = {
  'Content-Type': 'application/json',
  'api-key': '{{api-key}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
arrow_rightPHP - cURL
Snippet copied successfully.
application/json
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/responses',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "responseSet": [
        {
            "questionID": 12345678,
            "answerValues": [
                {
                    "answerID": 123456789
                }
            ]
        },
        {
            "questionID": 12345679,
            "answerValues": [
                {
                    "answerID": 100000001,
                    "value": {
                        "text": "FirstName"
                    }
                }
            ]
        },
        {
            "questionID": 83734737,
            "answerValues": [
                {
                    "answerID": 100000002,
                    "value": {
                        "text": "LastName"
                    }
                }
            ]
        },
        {
            "questionID": 83734738,
            "answerValues": [
                {
                    "answerID": 100000003,
                    "value": {
                        "text": "123-456-7890"
                    }
                }
            ]
        },
        {
            "questionID": 83734739,
            "answerValues": [
                {
                    "answerID": 100000004,
                    "value": {
                        "text": "respondentemail@emaildomain.com"
                    }
                }
            ]
        }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'api-key: {{api-key}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Responses

arrow_rightExample
application/json
{
     "response": {
         "responseID": 12345678,
         "surveyID": 7654321,
         "surveyName": "Test Survey",
         "ipAddress": "192.168.0.1",
         "timestamp": "05 Oct, 2020 02:51:51 PM PDT",
         "dataQuality": "unflagged",
         "dataQualityScore": 0.0,
         "location": {
             "country": null,
             "region": "16",
             "latitude": 0.0,
             "longitude": 0.0,
             "radius": 0.0,
             "countryCode": "IN"
         },
         "duplicate": false,
         "timeTaken": 41,
         "responseStatus": "Completed",
         "externalReference": "",
         "customVariables": {
             "custom1": null,
             "custom2": null,
             "custom3": null,
             "custom4": null,
             "custom5": null
         },
         "language": "English",
         "currentInset": "",
         "operatingSystem": "WINDOWS_10",
         "osDeviceType": "COMPUTER",
         "browser": "CHROME8",
         "responseSet": [
             {
                 "questionID": 12345678,
                 "questionDescription": " ",
                 "questionCode": "Q1",
                 "questionText": "How often do you conduct surveys?",
                 "imageUrl": null,
                 "answerValues": [
                     {
                         "answerID": 123456789,
                         "answerText": "Always",
                         "value": {
                             "scale": "1",
                             "other": "",
                             "dynamicExplodeText": "",
                             "text": "",
                             "result": "",
                             "fileLink": "",
                             "weight": 0.0
                         }
                     }
                 ]
             },
             {
                 "questionID": 12345679,
                 "questionDescription": "Contact Information",
                 "questionCode": "Q2_1",
                 "questionText": "First Name",
                 "imageUrl": null,
                 "answerValues": [
                     {
                         "answerID": 100000001,
                         "answerText": "FIRST_NAME",
                         "value": {
                             "scale": "",
                             "other": "",
                             "dynamicExplodeText": "",
                             "text": "FirstName",
                             "result": "",
                             "fileLink": "",
                             "weight": 0.0
                         }
                     }
                 ]
             },
             {
                 "questionID": 83734737,
                 "questionDescription": " ",
                 "questionCode": "Q2_2",
                 "questionText": "Last Name",
                 "imageUrl": null,
                 "answerValues": [
                     {
                         "answerID": 100000002,
                         "answerText": "LAST_NAME",
                         "value": {
                             "scale": "",
                             "other": "",
                             "dynamicExplodeText": "",
                             "text": "LastName",
                             "result": "",
                             "fileLink": "",
                             "weight": 0.0
                         }
                     }
                 ]
             },
             {
                 "questionID": 83734738,
                 "questionDescription": " ",
                 "questionCode": "Q2_3",
                 "questionText": "Phone",
                 "imageUrl": null,
                 "answerValues": [
                     {
                         "answerID": 100000003,
                         "answerText": "PHONE",
                         "value": {
                             "scale": "",
                             "other": "",
                             "dynamicExplodeText": "",
                             "text": "123-456-7890",
                             "result": "",
                             "fileLink": "",
                             "weight": 0.0
                         }
                     }
                 ]
             },
             {
                 "questionID": 83734739,
                 "questionDescription": " ",
                 "questionCode": "Q2_4",
                 "questionText": "Email Address",
                 "imageUrl": null,
                 "answerValues": [
                     {
                         "answerID": 100000004,
                         "answerText": "EMAIL",
                         "value": {
                             "scale": "",
                             "other": "",
                             "dynamicExplodeText": "",
                             "text": "respondentemail@emaildomain.com",
                             "result": "",
                             "fileLink": "",
                             "weight": 0.0
                         }
                     }
                 ]
             }
         ]
 },
     "requestID": "7012fedc-e8ce-48ae-b800-6q5ce287987a7dac"
 }
arrow_rightSchema
application/json
{
  "$schema": "http://json-schema.org/draft-06/schema# ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "surveyID": {
          "type": "integer"
        },
        "dataQualityScore": {
          "type": "number"
        },
        "ipAddress": {
          "type": "string",
          "format": "ipv4"
        },
        "language": {
          "type": "string"
        },
        "duplicate": {
          "type": "boolean"
        },
        "responseStatus": {
          "type": "string"
        },
        "operatingSystem": {
          "type": "string"
        },
        "customVariables": {
          "type": "object",
          "properties": {
            "custom3": {
              "type": "null"
            },
            "custom4": {
              "type": "null"
            },
            "custom1": {
              "type": "null"
            },
            "custom2": {
              "type": "null"
            },
            "custom5": {
              "type": "null"
            }
          },
          "additionalProperties": false
        },
        "externalReference": {
          "type": "string"
        },
        "osDeviceType": {
          "type": "string"
        },
        "timeTaken": {
          "type": "integer"
        },
        "currentInset": {
          "type": "string"
        },
        "dataQuality": {
          "type": "string"
        },
        "surveyName": {
          "type": "string"
        },
        "browser": {
          "type": "string"
        },
        "location": {
          "type": "object",
          "properties": {
            "country": {
              "type": "null"
            },
            "countryCode": {
              "type": "string"
            },
            "latitude": {
              "type": "number"
            },
            "region": {
              "type": "string"
            },
            "radius": {
              "type": "number"
            },
            "longitude": {
              "type": "number"
            }
          },
          "additionalProperties": false,
          "required": [
            "countryCode",
            "latitude",
            "region",
            "radius",
            "longitude"
          ]
        },
        "responseSet": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "questionDescription": {
                "type": "string"
              },
              "questionID": {
                "type": "integer"
              },
              "questionCode": {
                "type": "string"
              },
              "imageUrl": {
                "type": "null"
              },
              "answerValues": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "answerID": {
                      "type": "integer"
                    },
                    "answerText": {
                      "type": "string"
                    },
                    "value": {
                      "type": "object",
                      "properties": {
                        "result": {
                          "type": "string"
                        },
                        "other": {
                          "type": "string"
                        },
                        "fileLink": {
                          "type": "string"
                        },
                        "scale": {
                          "type": "string"
                        },
                        "dynamicExplodeText": {
                          "type": "string"
                        },
                        "weight": {
                          "type": "number"
                        },
                        "text": {
                          "anyOf": [
                            {
                              "type": "string",
                              "format": "email"
                            },
                            {
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "additionalProperties": false,
                      "required": [
                        "result",
                        "other",
                        "fileLink",
                        "scale",
                        "dynamicExplodeText",
                        "weight",
                        "text"
                      ]
                    }
                  },
                  "additionalProperties": false,
                  "required": [
                    "answerID",
                    "answerText",
                    "value"
                  ]
                }
              },
              "questionText": {
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "questionDescription",
              "questionID",
              "questionCode",
              "answerValues",
              "questionText"
            ]
          }
        },
        "responseID": {
          "type": "integer"
        },
        "timestamp": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "surveyID",
        "dataQualityScore",
        "ipAddress",
        "language",
        "duplicate",
        "responseStatus",
        "operatingSystem",
        "customVariables",
        "externalReference",
        "osDeviceType",
        "timeTaken",
        "currentInset",
        "dataQuality",
        "surveyName",
        "browser",
        "location",
        "responseSet",
        "responseID",
        "timestamp"
      ]
    },
    "requestID": {
      "type": "string"
    }
  },
  "additionalProperties": false,
  "required": [
    "response",
    "requestID"
  ]
}
arrow_right400 example
application/json
{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "BAD_REQUEST",
         "httpStatusCode": 400,
         "id" : "1000",
         "message": "Invalid URL parameters",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json
{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right401 example
application/json
{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "UNAUTHORIZED",
         "httpStatusCode": 401,
         "id" : "1010",
         "message": "Incorrect API Key",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json
{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right403 example
application/json
{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "FORBIDDEN",
         "httpStatusCode": 403,
         "id" : "1013",
         "message": "The user does not have permission to access the resource",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json
{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right404 example
application/json
{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "NOT_FOUND",
         "httpStatusCode": 404,
         "id" : "1040",
         "message": "The resource that you're trying to access doesn't exist",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json
{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right500 example
application/json
{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "INTERNAL_SERVER_ERROR",
         "httpStatusCode": 500,
         "id" : "1026",
         "message": "We are not able to process your request",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json
{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}