API to export survey definition

Question

Hi folks,Experienced developer here. I’m trying to automate the release management (continuous deployment) of our surveys in our Qualtrics tenant. I understand there is documentation around the importing of a survey definition (qsf ) file, but I cannot find any guidance/post in the QX community about exporting a qsf file through an API.Using Chrome’s dev tools, I’ve been able to identify the API endpoint located at …https://<>.az1.qualtrics.com/Q/EditSection/Post/ExportSurvey?SurveyID=<>... to perform this export but it doesn’t seem to accept the “X-API-token” in the request header as a means of authorization (as other publicly-documented QX APIs successfully accept).Questions:Does anyone have any solution to address this problem? Are there any plans on making this API publicly documented like the related importSurvey API? (and not force our deployment-automation process to use something like Selenium to generate a UDSSessionID [of a user] to be used in the httpRequest’s cookie?)Thanks for reading and I must say that having this problem resolved would be a HUGE help to making this overall platform more CI/CD-friendly.marko

w.patrick.gale · Answer

Hey markogotovac,😀The following API would get you what you need with a small amount ofparsing:https://api.qualtrics.com/9d0928392673d-get-surveyFor me I am using Python to query thisAPI, so I use a function like the following to retrieve the survey template data:def GetSurveyDefinition(strSurveyId, strApiToken):  url = _CONFIG_["QAPI_ROOTURL"]+"survey-definitions/"+strSurveyId+"?format=qsf"  headers = {    "Content-Type": "application/json",    "X-API-TOKEN": strApiToken  }  response = requests.request("GET", url, headers=headers)  jsonResponse = json.loads(response.text)  # convert the text JSON to a JSON object  print("export status: ",jsonResponse['meta']['httpStatus'])  return jsonResponsesurveyTemplate = GetSurveyDefinition(strSurveyId, _CONFIG_["QAPI_TOKEN"])with open(_CONFIG_["DOCKER_MOUNT_DIR"]+"/data/"+strSurveyId+".qsf", mode='w') as jsonFile:    jsonFile.write(json.dumps(surveyTemplate["result"], indent=2))The important thing is that you only wantthe`surveyTemplate["result"]` to use as yoursurvey template file contents.

Sign up

Login to the Community

Scanning file for viruses.

This file cannot be downloaded