API V2

Datapad keyboard_arrow_down

Put /surveys/{{survey-id}}/datapads/{{datapad-id}}

Example Request

https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/datapads/{{datapad-id}}?apiKey={{apiKey}}

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

Authorization

arrow_rightKey - apiKey
  • Name: apiKey
  • Location: query

Request Parameters

arrow_rightPath Parameters
survey-id integer
required
datapad-id integer
required

Request Body

arrow_rightPayload
application/json 

                          {
                                "analysisHtmlText": "{{your-system-file-path}}"
                           }

Example Code

arrow_rightcURL
application/json 

                          curl --request PUT \
                               --url 'https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/datapads/{{datapad-id}}?apiKey={{apiKey}}'
                               --header 'Content-Type: application/json' \
                               --data '{ "analysisHtmlText": {{your-system-file-path}} }'
arrow_rightPython
application/json 

                               import requests
   
                               url = "https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/datapads/{{datapad-id}}?apiKey={{apiKey}}"
                               
                               querystring = {"apiKey":"{{apiKey}}"}
                               
                               payload = "{\n           \"analysisHtmlText\": \"{{your-system-file-path}} \" }"
                               
                               headers = {'Content-Type': 'application/json'}
                               
                               response = requests.request("PUT", url, data=payload, headers=headers, params=querystring)
                               
                               print(response.text)
arrow_rightPHP
application/json 

                    <?php
                                $curl = curl_init();
            
                                curl_setopt_array($curl, array(
                                CURLOPT_URL =>"https://{{env}}.questionpro.com/a/api/v2/surveys/{{survey-id}}/datapads/{{datapad-id}}?apiKey={{apiKey}}",
                                CURLOPT_RETURNTRANSFER => true,
                                CURLOPT_ENCODING => "",
                                CURLOPT_MAXREDIRS => 10,
                                CURLOPT_TIMEOUT => 30,
                                CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                                CURLOPT_CUSTOMREQUEST => "PUT",
                                CURLOPT_POSTFIELDS => "{\n            \"analysisHtmlText\": \"{{your-system-file-path}} " }",
                                CURLOPT_HTTPHEADER => array(
                                "Content-Type: application/json"
                                   ),
                                   ));
                                   
                                $response = curl_exec($curl);
                                $err = curl_error($curl);
                                   
                                curl_close($curl);
                                   
                                   if ($err) {
                                   echo "cURL Error # :" . $err;
                                   } else {
                                   echo $response;
                                   }
                               ?>

Responses

arrow_rightExample
application/json 

                          { 
                       "response": 
                       { 
                           "datapadID": 234, 
                           "title": "Covid 19 Survey", 
                           "description": "The Sample Survey survey was fielded on 08/Apr/2020 and about 118 respondents took the survey. The survey was administered using QuestionPro. This allowed users to submit their responses securely online. Listed below are the key findings.\n ", 
                           "analysisHtmlText": "HTML Text", 
                           "urls": 
                           { 
                               "report": "https://{{env}}.questionpro.com/t/4GaZRIYe", 
                               "csv": "https://{{env}}.questionpro.com/a/ds/?t=WWlIYk5GO6Mwt9MfLXhTfLBib3M%2BhxKTbxdi1CiLH8RfyZAXvSpt444qUNxeXPI/", 
                               "excel": "https://{{env}}.questionpro.com/a/ds/?t=RK%2BdbpZbjLB0BiW/mAbotqUnwMUyn73fRHNn0NiU9EPRYzMVExj6ev2BYVG94yAq" 
                               
                           }, 
                           "surveyID": 1234567
                        } 
                       
                   }
arrow_rightSchema
application/json
{
  "$schema": "http://json-schema.org/draft-06/schema# ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "urls": {
          "type": "object",
          "properties": {
            "excel": {
              "type": "string"
            },
            "csv": {
              "type": "string"
            },
            "report": {
              "type": "string"
            }
          },
          "additionalProperties": false,
          "required": [
            "excel",
            "csv",
            "report"
          ]
        },
        "surveyID": {
          "type": "integer"
        },
        "description": {
          "type": "string"
        },
        "datapadID": {
          "type": "integer"
        },
        "analysisHtmlText": {
          "type": "string"
        },
        "title": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "required": [
        "urls",
        "surveyID",
        "description",
        "datapadID",
        "analysisHtmlText",
        "title"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
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"
  ]
}