Embedded Data in Create Survey Distribution API | XM Community
Skip to main content
Solved

Embedded Data in Create Survey Distribution API


Hello,
I have a question regarding the Create Survey Distribution API. When I send fields and values as embeddedData, how can I use these values in the Survey Flow? E.g. I want to show in the Survey introduction section an activity number sent in the embedded Data.
And where can I see these values in the platform? The Get Distribution API returns the correct values of the embedded data, but I can't find them in the platform.
Many thanks in advance!
Gaspar

Best answer by TomG

@GTissera,

The following note is on the create survey distribution doc page:

!

So that data is not intended to be used in the survey as you are trying to do. Personally, I think Qualtrics should have named it something other than 'embeddedData' because it is misleading.
View original

13 replies

PeeyushBansal
Level 6 ●●●●●●
Forum|alt.badge.img+39
  • Level 6 ●●●●●●
  • 1143 replies
  • August 13, 2018
In survey flow at start you can add new element as embedded data and name your embedded variable that you are passing in API using webservice. This embedded variable you can pipe in survey introduction.

you can also refer below:-
https://www.qualtrics.com/support/survey-platform/survey-module/survey-flow/advanced-elements/web-service/

  • Author
  • 9 replies
  • August 13, 2018
Hi Bansal,
So I added the new field as a new element in the embedded data with the same name as in the API request:
!

And then I piped it in the Survey Introduction:
!

But when I take the Survey, it is not displaying the activityId value.
!

Do you know if I am missing any step?
Thanks,
Gaspar

PeeyushBansal
Level 6 ●●●●●●
Forum|alt.badge.img+39
  • Level 6 ●●●●●●
  • 1143 replies
  • August 13, 2018
Hi @GTissera ,

please add as per below link you have to add webservice too:-

https://www.qualtrics.com/support/survey-platform/survey-module/survey-flow/advanced-elements/web-service/

  • Author
  • 9 replies
  • August 13, 2018
Hello Bansal,
So you mean that the embedded data can't be accessed from within the distribution instance and instead I should request the GET method of distribution API to retrieve the desired embedded Data?
Thanks
Gaspar

PeeyushBansal
Level 6 ●●●●●●
Forum|alt.badge.img+39
  • Level 6 ●●●●●●
  • 1143 replies
  • August 13, 2018
Yes, we cant directly access it when creating with api.

  • Author
  • 9 replies
  • August 13, 2018
But this distribution was already created with API and I cannot access it directly in the distribution:
!
Thanks,
Gaspar

MohammedAli_Rajapkar
QPN Level 5 ●●●●●
Forum|alt.badge.img+20
Can you try adding the embedded data in "contact list" for that specific contacts? and remove it from this distribution API.

sankeshkumar
QPN Level 2 ●●
Forum|alt.badge.img+1
  • QPN Level 2 ●●
  • 16 replies
  • August 13, 2018
hello @GTissera
Follow this Link https://api.qualtrics.com/docs/insert-embedded-data-fields

  • Author
  • 9 replies
  • August 13, 2018
@Mohammedali_Rajapakar_Ugam No, because it should on the distribution level and not on the contact level. There is a case of a Contact with more than one activityId's.
@sankeshkumar This API seems to be useful to add embedded data on the Survey on design activities, but not to add values to a specific distributionId.

I'm still looking for advice on this.
Thanks,
Gaspar

TomG
Level 8 ●●●●●●●●
Forum|alt.badge.img+27
  • Level 8 ●●●●●●●●
  • 5909 replies
  • Answer
  • August 13, 2018
@GTissera,

The following note is on the create survey distribution doc page:

!

So that data is not intended to be used in the survey as you are trying to do. Personally, I think Qualtrics should have named it something other than 'embeddedData' because it is misleading.

  • Author
  • 9 replies
  • August 14, 2018
@TomG I definitely agree with you. Is it somehow possible that this request reaches the Qualtrics dev team? Maybe they have an answer for this.

Thanks.

PeeyushBansal
Level 6 ●●●●●●
Forum|alt.badge.img+39
  • Level 6 ●●●●●●
  • 1143 replies
  • August 14, 2018
@GTissera , you have to open ticlet with support team:
https://www.qualtrics.com/support-center/?Product=survey-platform

LaurenK
Former XM Community Team Member
Forum|alt.badge.img+13
  • Former XM Community Team Member
  • 900 replies
  • August 14, 2018
Hi @TomG and @GTissera! Feel free to post this in our Product Ideas category, as it is a feature not already developed by our team. Be sure to review the How to Write a Good Product Idea template and our Ideation Guidelines before you post your idea! 🙂

Leave a Reply