How can I get survey logic through the API? | XM Community
Solved

How can I get survey logic through the API?

  • 31 August 2018
  • 3 replies
  • 92 views

Recently, I've developed some tools for getting surveys from the API and formatting them as nice, clean PDF files. As of now, they work well for blocks and questions. I'd like to extend them to include survey logic (survey flow branches, display logic, and skip logic). The issue is that none of these things are fully described in the json returned by the get survey API. Survey flow branches are indicated, but not identified or annotated in any way, and the other two don't appear to be present at all.

This is especially strange to me considering the .qsf (json) exports that can be manually exported from the survey editor interface include extremely detailed information about all three type of logic. Unfortunately, they seem to use a different system of internal identifiers for questions, though there seems to be agreement on the user-defined names, so a cludgy work-around is probably do-able.

My questions are:

(practical)
1. are there undocumented parameters that would force the API's response to include more detailed information about logic and flow?
2. is there a way to programatically get the same .qsf file that would be exported from the survey editor interface?

(curious)
3. why is it good or helpful to have the api export a different set of information than the editor interface?
icon

Best answer by AnthonyR 31 August 2018, 18:03

View original

3 replies

Userlevel 7
Badge +7
@tmcmanus Unfortunately there is no way to get the more detailed qsf from the api. I have made a request for this to be added, and recommend you do too! The more voices that they hear about a request the more likely it becomes.

I have had the same question regarding the usefulness of 2 different file types for a long time, hopefully we are able to get the qsf from the api sooner rather than later.

tmcmanus This is incredibly helpful!
I see this question is from 2018, do you know if they ever added the skip logic to the API calls?

I am looking for this feature as well and so far I dont see any news on this as well.

Leave a Reply