Domain > apidocs.surveydynamix.com

More information on this domain is in AlienVault OTX

DNS Resolutions

Date	IP Address
2020-12-12	52.85.79.67 (ClassC)
2021-02-02	54.230.18.35 (ClassC)
2025-04-09	99.86.74.116 (ClassC)
2025-04-09	99.86.74.54 (ClassC)
2025-07-01	3.171.76.32 (ClassC)
2025-07-01	3.171.76.91 (ClassC)
2026-02-24	143.204.160.80 (ClassC)

HTTP/1.1 200 OKContent-Type: text/htmlContent-Length: 455765Connection: keep-aliveDate: Tue, 24 Feb 2026 09:38:13 GMTLast-Modified: Fri, 10 May 2024 05:42:25 GMTETag: 831c26eb384fbbdcd0d32e85930ec164x-amz-server-side-encryption: AES256x-amz-version-id: C_zoPaHPS6e2SdIwLHLWaPQxwIW4Zu1qAccept-Ranges: bytesServer: AmazonS3X-Cache: Miss from cloudfrontVia: 1.1 e088ff8bff69861ed7fd37fbb518f0c2.cloudfront.net (CloudFront)X-Amz-Cf-Pop: SEA900-P9X-Amz-Cf-Id: DKv4Fib3_evKRclBsxBtkqrmdtx0pviEXOUH3jE3AfngoD6cL8bjzA

!doctype html>html>  head>    meta charsetutf-8>    meta contentIEedge,chrome1 http-equivX-UA-Compatible>    meta nameviewport contentwidthdevice-width, initial-scale1, maximum-scale1>    title>API Reference/title>    style mediascreen>      .highlight table td { padding: 5px; }.highlight table pre { margin: 0; }.highlight .gh {  color: #999999;}.highlight .sr {  color: #f6aa11;}.highlight .go {  color: #888888;}.highlight .gp {  color: #555555;}.highlight .gs {}.highlight .gu {  color: #aaaaaa;}.highlight .nb {  color: #f6aa11;}.highlight .cm {  color: #75715e;}.highlight .cp {  color: #75715e;}.highlight .c1 {  color: #75715e;}.highlight .cs {  color: #75715e;}.highlight .c, .highlight .ch, .highlight .cd, .highlight .cpf {  color: #75715e;}.highlight .err {  color: #960050;}.highlight .gr {  color: #960050;}.highlight .gt {  color: #960050;}.highlight .gd {  color: #49483e;}.highlight .gi {  color: #49483e;}.highlight .ge {  color: #49483e;}.highlight .kc {  color: #66d9ef;}.highlight .kd {  color: #66d9ef;}.highlight .kr {  color: #66d9ef;}.highlight .no {  color: #66d9ef;}.highlight .kt {  color: #66d9ef;}.highlight .mf {  color: #ae81ff;}.highlight .mh {  color: #ae81ff;}.highlight .il {  color: #ae81ff;}.highlight .mi {  color: #ae81ff;}.highlight .mo {  color: #ae81ff;}.highlight .m, .highlight .mb, .highlight .mx {  color: #ae81ff;}.highlight .sc {  color: #ae81ff;}.highlight .se {  color: #ae81ff;}.highlight .ss {  color: #ae81ff;}.highlight .sd {  color: #e6db74;}.highlight .s2 {  color: #e6db74;}.highlight .sb {  color: #e6db74;}.highlight .sh {  color: #e6db74;}.highlight .si {  color: #e6db74;}.highlight .sx {  color: #e6db74;}.highlight .s1 {  color: #e6db74;}.highlight .s, .highlight .sa, .highlight .dl {  color: #e6db74;}.highlight .na {  color: #a6e22e;}.highlight .nc {  color: #a6e22e;}.highlight .nd {  color: #a6e22e;}.highlight .ne {  color: #a6e22e;}.highlight .nf, .highlight .fm {  color: #a6e22e;}.highlight .vc {  color: #ffffff;}.highlight .nn {  color: #ffffff;}.highlight .ni {  color: #ffffff;}.highlight .bp {  color: #ffffff;}.highlight .vg {  color: #ffffff;}.highlight .vi {  color: #ffffff;}.highlight .nv, .highlight .vm {  color: #ffffff;}.highlight .w {  color: #ffffff;}.highlight {  color: #ffffff;}.highlight .n, .highlight .py, .highlight .nx {  color: #ffffff;}.highlight .nl {  color: #f92672;}.highlight .ow {  color: #f92672;}.highlight .nt {  color: #f92672;}.highlight .k, .highlight .kv {  color: #f92672;}.highlight .kn {  color: #f92672;}.highlight .kp {  color: #f92672;}.highlight .o {  color: #f92672;}    /style>    style mediaprint>      * {        -webkit-transition:none!important;        transition:none!important;      }      .highlight table td { padding: 5px; }.highlight table pre { margin: 0; }.highlight, .highlight .w {  color: #586e75;}.highlight .err {  color: #002b36;  background-color: #dc322f;}.highlight .c, .highlight .ch, .highlight .cd, .highlight .cm, .highlight .cpf, .highlight .c1, .highlight .cs {  color: #657b83;}.highlight .cp {  color: #b58900;}.highlight .nt {  color: #b58900;}.highlight .o, .highlight .ow {  color: #93a1a1;}.highlight .p, .highlight .pi {  color: #93a1a1;}.highlight .gi {  color: #859900;}.highlight .gd {  color: #dc322f;}.highlight .gh {  color: #268bd2;  background-color: #002b36;  font-weight: bold;}.highlight .k, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kv {  color: #6c71c4;}.highlight .kc {  color: #cb4b16;}.highlight .kt {  color: #cb4b16;}.highlight .kd {  color: #cb4b16;}.highlight .s, .highlight .sb, .highlight .sc, .highlight .dl, .highlight .sd, .highlight .s2, .highlight .sh, .highlight .sx, .highlight .s1 {  color: #859900;}.highlight .sa {  color: #6c71c4;}.highlight .sr {  color: #2aa198;}.highlight .si {  color: #d33682;}.highlight .se {  color: #d33682;}.highlight .nn {  color: #b58900;}.highlight .nc {  color: #b58900;}.highlight .no {  color: #b58900;}.highlight .na {  color: #268bd2;}.highlight .m, .highlight .mb, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mx {  color: #859900;}.highlight .ss {  color: #859900;}    /style>    link hrefstylesheets/screen-f83df0e8.css relstylesheet mediascreen />    link hrefstylesheets/print-953e3353.css relstylesheet mediaprint />      script srcjavascripts/all-b12a2749.js>/script>  /head>  body classindex data-languages"shell","python","php","javascript">    a href# idnav-button>      span>        NAV        img srcimages/navbar-cad8cdcb.png alt />      /span>    /a>    div classtoc-wrapper>      img srcimages/mf_logo_large_grey-938b6b61.svg classlogo alt />        div classlang-selector>              a href# data-language-nameshell>cURL/a>              a href# data-language-namepython>python/a>              a href# data-language-namephp>php/a>              a href# data-language-namejavascript>javascript/a>        /div>        div classsearch>          input typetext classsearch idinput-search placeholderSearch>        /div>        ul classsearch-results>/ul>      ul idtoc classtoc-list-h1>          li>            a href#introduction classtoc-h1 toc-link data-titleIntroduction>Introduction/a>          /li>          li>            a href#using-the-api classtoc-h1 toc-link data-titleUsing the API>Using the API/a>              ul classtoc-list-h2>                  li>                    a href#base-url classtoc-h2 toc-link data-titleBase URL>Base URL/a>                  /li>                  li>                    a href#authentication classtoc-h2 toc-link data-titleAuthentication>Authentication/a>                  /li>                  li>                    a href#rate-limiting classtoc-h2 toc-link data-titleRate Limiting>Rate Limiting/a>                  /li>              /ul>          /li>          li>            a href#interactions classtoc-h1 toc-link data-titleInteractions>Interactions/a>              ul classtoc-list-h2>                  li>                    a href#get-interactions-list classtoc-h2 toc-link data-titleGet Interactions List>Get Interactions List/a>                  /li>                  li>                    a href#add-new-interaction classtoc-h2 toc-link data-titleAdd New Interaction>Add New Interaction/a>                  /li>                  li>                    a href#get-specific-interaction-s classtoc-h2 toc-link data-titleGet Specific Interaction(s)>Get Specific Interaction(s)/a>                  /li>                  li>                    a href#delete-interaction classtoc-h2 toc-link data-titleDelete Interaction>Delete Interaction/a>                  /li>                  li>                    a href#update-interaction classtoc-h2 toc-link data-titleUpdate Interaction>Update Interaction/a>                  /li>                  li>                    a href#get-responses-list-by-interaction classtoc-h2 toc-link data-titleGet Responses List By Interaction>Get Responses List By Interaction/a>                  /li>                  li>                    a href#get-interaction-data-list-by-interaction classtoc-h2 toc-link data-titleGet Interaction Data List By Interaction>Get Interaction Data List By Interaction/a>                  /li>                  li>                    a href#start-survey classtoc-h2 toc-link data-titleStart Survey>Start Survey/a>                  /li>                  li>                    a href#submit-survey-response classtoc-h2 toc-link data-titleSubmit Survey Response>Submit Survey Response/a>                  /li>                  li>                    a href#abandon-survey classtoc-h2 toc-link data-titleAbandon Survey>Abandon Survey/a>                  /li>              /ul>          /li>          li>            a href#interaction-data classtoc-h1 toc-link data-titleInteraction Data>Interaction Data/a>              ul classtoc-list-h2>                  li>                    a href#get-interaction-data-list classtoc-h2 toc-link data-titleGet Interaction Data List>Get Interaction Data List/a>                  /li>                  li>                    a href#get-specific-interaction-data classtoc-h2 toc-link data-titleGet Specific Interaction Data>Get Specific Interaction Data/a>                  /li>                  li>                    a href#set-interaction-data classtoc-h2 toc-link data-titleSet Interaction Data>Set Interaction Data/a>                  /li>                  li>                    a href#delete-interaction-data classtoc-h2 toc-link data-titleDelete Interaction Data>Delete Interaction Data/a>                  /li>              /ul>          /li>          li>            a href#responses classtoc-h1 toc-link data-titleResponses>Responses/a>              ul classtoc-list-h2>                  li>                    a href#get-responses-list classtoc-h2 toc-link data-titleGet Responses List>Get Responses List/a>                  /li>                  li>                    a href#get-specific-response classtoc-h2 toc-link data-titleGet Specific Response>Get Specific Response/a>                  /li>              /ul>          /li>          li>            a href#surveys classtoc-h1 toc-link data-titleSurveys>Surveys/a>              ul classtoc-list-h2>                  li>                    a href#get-surveys-list classtoc-h2 toc-link data-titleGet Surveys List>Get Surveys List/a>                  /li>                  li>                    a href#get-specific-survey classtoc-h2 toc-link data-titleGet Specific Survey>Get Specific Survey/a>                  /li>                  li>                    a href#get-questions-list-by-survey classtoc-h2 toc-link data-titleGet Questions List By Survey>Get Questions List By Survey/a>                  /li>                  li>                    a href#get-interactions-list-by-survey classtoc-h2 toc-link data-titleGet Interactions List By Survey>Get Interactions List By Survey/a>                  /li>                  li>                    a href#get-interaction-data-list-by-survey classtoc-h2 toc-link data-titleGet Interaction Data List By Survey>Get Interaction Data List By Survey/a>                  /li>                  li>                    a href#get-responses-list-by-survey classtoc-h2 toc-link data-titleGet Responses List By Survey>Get Responses List By Survey/a>                  /li>              /ul>          /li>          li>            a href#questions classtoc-h1 toc-link data-titleQuestions>Questions/a>              ul classtoc-list-h2>                  li>                    a href#get-questions-list classtoc-h2 toc-link data-titleGet Questions List>Get Questions List/a>                  /li>                  li>                    a href#get-specific-question classtoc-h2 toc-link data-titleGet Specific Question>Get Specific Question/a>                  /li>                  li>                    a href#get-responses-list-by-question classtoc-h2 toc-link data-titleGet Responses List By Question>Get Responses List By Question/a>                  /li>              /ul>          /li>          li>            a href#users classtoc-h1 toc-link data-titleUsers>Users/a>              ul classtoc-list-h2>                  li>                    a href#get-users-list classtoc-h2 toc-link data-titleGet Users List>Get Users List/a>                  /li>                  li>                    a href#get-specific-user classtoc-h2 toc-link data-titleGet Specific User>Get Specific User/a>                  /li>                  li>                    a href#get-interactions-list-by-user classtoc-h2 toc-link data-titleGet Interactions List By User>Get Interactions List By User/a>                  /li>              /ul>          /li>          li>            a href#user-groups classtoc-h1 toc-link data-titleUser Groups>User Groups/a>              ul classtoc-list-h2>                  li>                    a href#get-user-groups-list classtoc-h2 toc-link data-titleGet User Groups List>Get User Groups List/a>                  /li>                  li>                    a href#get-specific-user-group classtoc-h2 toc-link data-titleGet Specific User Group>Get Specific User Group/a>                  /li>                  li>                    a href#get-users-from-user-group classtoc-h2 toc-link data-titleGet Users from User Group>Get Users from User Group/a>                  /li>                  li>                    a href#create-new-user-group classtoc-h2 toc-link data-titleCreate New User Group>Create New User Group/a>                  /li>                  li>                    a href#add-users-to-user-group classtoc-h2 toc-link data-titleAdd Users to User Group>Add Users to User Group/a>                  /li>                  li>                    a href#remove-users-from-user-group classtoc-h2 toc-link data-titleRemove Users from User Group>Remove Users from User Group/a>                  /li>              /ul>          /li>          li>            a href#do-not-call-list classtoc-h1 toc-link data-titleDo Not Call List>Do Not Call List/a>              ul classtoc-list-h2>                  li>                    a href#get-do-not-call-list classtoc-h2 toc-link data-titleGet Do Not Call List>Get Do Not Call List/a>                  /li>                  li>                    a href#get-specific-do-not-call-list-entry classtoc-h2 toc-link data-titleGet Specific Do Not Call List Entry>Get Specific Do Not Call List Entry/a>                  /li>                  li>                    a href#add-do-not-call-list-entry classtoc-h2 toc-link data-titleAdd Do Not Call List Entry>Add Do Not Call List Entry/a>                  /li>                  li>                    a href#delete-do-not-call-list-entry classtoc-h2 toc-link data-titleDelete Do Not Call List Entry>Delete Do Not Call List Entry/a>                  /li>              /ul>          /li>          li>            a href#survey-prompts classtoc-h1 toc-link data-titleSurvey Prompts>Survey Prompts/a>              ul classtoc-list-h2>                  li>                    a href#survey-text-prompts classtoc-h2 toc-link data-titleSurvey Text Prompts>Survey Text Prompts/a>                  /li>              /ul>          /li>          li>            a href#phone-numbers classtoc-h1 toc-link data-titlePhone Numbers>Phone Numbers/a>              ul classtoc-list-h2>                  li>                    a href#get-phone-number-details classtoc-h2 toc-link data-titleGet Phone Number Details>Get Phone Number Details/a>                  /li>              /ul>          /li>          li>            a href#pstn-transfer-reservations classtoc-h1 toc-link data-titlePSTN Transfer Reservations>PSTN Transfer Reservations/a>              ul classtoc-list-h2>                  li>                    a href#add-new-pstn-transfer-reservation classtoc-h2 toc-link data-titleAdd New PSTN Transfer Reservation>Add New PSTN Transfer Reservation/a>                  /li>              /ul>          /li>          li>            a href#sip-transfer-reservations classtoc-h1 toc-link data-titleSIP Transfer Reservations>SIP Transfer Reservations/a>              ul classtoc-list-h2>                  li>                    a href#add-new-sip-transfer-reservation classtoc-h2 toc-link data-titleAdd New SIP Transfer Reservation>Add New SIP Transfer Reservation/a>                  /li>              /ul>          /li>          li>            a href#supported-languages classtoc-h1 toc-link data-titleSupported Languages>Supported Languages/a>              ul classtoc-list-h2>                  li>                    a href#defaults classtoc-h2 toc-link data-titleDefaults>Defaults/a>                  /li>              /ul>          /li>          li>            a href#errors classtoc-h1 toc-link data-titleErrors>Errors/a>          /li>      /ul>        ul classtoc-footer>            li>a hrefhttps://surveydynamix.com>Visit Mindful Feedback/a>/li>        /ul>    /div>    div classpage-wrapper>      div classdark-box>/div>      div classcontent>        h1 idintroduction>Introduction/h1>p>Welcome to the Mindful Feedback REST API Reference version 1.5.8/p>p>The Feedback API allows you to programmatically add survey interactions, retrieve results and even perform surveys via your own applications./p>p>This page details all the API resources you will need to create powerful integrations with Mindful Feedback./p>h1 idusing-the-api>Using the API/h1>h2 idbase-url>Base URL/h2>p>All API calls referenced in this document can be used with one of the following base URLs:/p>p>code>https://surveydynamix.com/api/code>/p>p>code>https://us2.surveydynamix.com/api/code>/p>p>code>https://au1.surveydynamix.com/api/code>/p>p>code>https://eu1.surveydynamix.com/api/code>/p>p>code>https://ca1.surveydynamix.com/api/code>/p>p>code>https://demo.surveydynamix.com/api/code>/p>p>Make sure to use the base URL with the same domain as the URL you use to log into Mindful Feedback. Throughout this documentation, the URL being used for examples is code>https://surveydynamix.com/api/code>, but you may need to use a different URL./p>p>To get the api endpoint for an individual request, append the URI listed in the request details to the base URL./p>p>The Mindful Feedback REST API is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported. /p>h2 idauthentication>Authentication/h2>h3 idoauth2>OAuth2/h3>p>The Feedback API supports authorisation code grant and personal access token methods. This documentation assumes you are already familiar with OAuth2 grant flows./p>h3 idauthorisation-code-grant>Authorisation Code Grant/h3>blockquote>p>To authorise API calls using an Authorisation Code, use this code:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>span classc># Using an access token, pass the token as part of the authorisation header with each request/span>curl span classs2>api_endpoint_here/span> span classse>\/span>  span classnt>-H/span> span classs2>Authorization: Bearer {Token}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>Authorization/span>span classp>:/span> span classs>Bearer {Token}/span>span classp>,/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://api_endpoint_here/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://api_endpoint_here/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Authorization: Bearer {Token}/span>span classp>;/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://api_endpoint_here/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Bearer {Token}/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>blockquote>p>Make sure to replace code>{Token}/code> with the access token./p>/blockquote>p>Mindful Feedback users with admin privileges can create OAuth clients by choosing the Integrations tab on the Customer Settings page./p>p>We use the standard OAuth2 authorisation code flow. To start, the client application must redirect the user to the Mindful authorisation endpoint at code>http://surveydynamix.com/oauth/authorize/code>. The redirect must include the following parameters:/p>table>thead>tr>th>Name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>response_type/code>/td>td>This will be set to code>code/code>./td>/tr>tr>td>code>client_id/code>/td>td>This is listed in the OAuth Clients table after you have created a client./td>/tr>tr>td>code>redirect_uri/code>/td>td>This must match the redirect URL that was specified when creating the client and will be used for the callback endpoint when the user grants access./td>/tr>tr>td>code>refresh_token/code>/td>td>The token used to refresh access token./td>/tr>/tbody>/table>p>Once the user has been redirected, they will be presented with a form allowing them to either approve or cancel the request. If the request is approved, the user will be redirected back to the redirect URL. This redirect will include a authorisation code./p>p>To convert the authorisation code into an access token, the client application must make a final POST request to the access token endpoint at code>http://surveydynamix.com/oauth/token/code> with the following parameters:/p>ul>li>code>grant_type/code>: This will be set to code>authorization_code/code>/li>li>code>client_id/code>: This is listed in the OAuth Clients table after you have created a client./li>li>code>client_secret/code>: This is listed in the OAuth Clients table and should be kept secure./li>li>code>redirect_uri/code>: This must match the redirect URL that was specified when creating the client and will be used for the callback endpoint when the user grants access./li>li>code>code/code>: Use the authorisation code included in the post-authorisation redirect./li>/ul>p>This request will return a JSON response containing the code>access_token/code> attribute./p>p>To authenticate using an access token add an authorisation header to each request in the following format:/p>p>code>Authorization: Bearer {access token}/code>/p>h3 idrefresh-access-tokens>Refresh Access Tokens/h3>blockquote>p>To refresh a access token using a code>refresh_token/code> use this code:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST   span classs2>https://surveydynamix.com/api/oauth/token/span> span classse>\/span>    span classnt>-d/span> span classs2>grant_typerefresh_token/span> span classse>\/span>    span classnt>-d/span> span classs2>refresh_tokenxxxxxx/span> span classse>\/span>    span classnt>-d/span> span classs2>client_idxxxxxx/span> span classse>\/span>    span classnt>-d/span> span classs2>client_secretxxxxxx/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/oauth/token/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>POST/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Type/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>application/x-www-form-urlencoded/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/oauth/token/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POSTFIELDS/span>span classp>,/span> span classs2>grant_typerefresh_token&refresh_tokenxxxxxx&client_idxxxxxx&client_secretxxxxxx/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POST/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Content-Type: application/x-www-form-urlencoded/span>span classp>;/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>data/span> span classo>/span> span classs>grant_typerefresh_token&refresh_tokenxxxxxx&client_idxxxxxx&client_secretxxxxxx/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/oauth/token/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>data/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>h3 iduri>URI/h3>p>code>/oauth/token/code>/p>h3 idmethod>Method/h3>p>code>POST/code>/p>h3 idparameters>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>grant_type/code>/td>td>The Refresh Token grant type is used by clients to exchange a refresh token for an access token when the access token has expired. To retrieve a new access token using the refresh token, set this field to code>refresh_token/code>/td>/tr>tr>td>code>refresh_token/code>/td>td>The token used to refresh access token./td>/tr>tr>td>code>client_id/code>/td>td>This is listed in the OAuth Clients table after you have created a client./td>/tr>tr>td>code>client_secret/code>/td>td>This is listed in the OAuth Clients table and should be kept secure./td>/tr>/tbody>/table>h3 idpersonal-access-tokens>Personal Access Tokens/h3>blockquote>p>To authorise API calls using a Personal Access Token, use this code:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>span classc># Using personal access token auth, pass the token as part of the authorisation header with each request/span>curl span classs2>api_endpoint_here/span> span classse>\/span>  span classnt>-H/span> span classs2>Authorization: Bearer {Token}/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>Authorization/span>span classp>:/span> span classs>Bearer {Token}/span>span classp>,/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://api_endpoint_here/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://api_endpoint_here/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Authorization: Bearer {Token}/span>span classp>;/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://api_endpoint_here/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Bearer {Token}/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>blockquote>p>Make sure to replace code>{Token}/code> with your  personal access token./p>/blockquote>p>Mindful users with admin privileges can create personal access tokens to authenticate API calls by choosing the Integrations tab on the Customer Settings page.  /p>p>Personal access tokens are shown to the user em>only once/em> upon creation and should be stored securely./p>p>To authenticate using a personal access token add an authorisation header to each request in the following format:/p>p>code>Authorization: Bearer {personal access token}/code>/p>h3 idbasic-authentication>Basic Authentication/h3>blockquote>p>To authorise API calls using Basic Authentication, use this code:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>span classc># Using Basic Auth, pass the default API credentials with each API call/span>curl span classs2>api_endpoint_here/span> span classse>\/span>  span classnt>-u/span> CustomerUUID:AuthToken/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>api_endpoint_here/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>CustomerUUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>AuthToken/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://api_endpoint_here/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://api_endpoint_herese/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>blockquote>p>Make sure to replace code>CustomerUUID:AuthToken/code> with your specific api credentials./p>/blockquote>p>Basic Authentication is the simplest authentication method that Mindful offers. You will use your customer Uuid as the username and your generated auth token as the password./p>p>You can find your customer authentication credentials on the Customer Settings page under General Settings. /p>p>username: code>Customer Uuid/code>/p>p>password: code>Auth Token/code>/p>h2 idrate-limiting>Rate Limiting/h2>p>The Mindful Feedback API applies rate limiting on a per-customer basis to prevent excessive usage. The rate limit for most API methods is 120 requests per minute. When a rate limit is exceeded, the API returns an HTTP 429 response./p>p>When a request is made to Feedback, the response will contain the following headers to indicate how close the application is to the limit and when the rate limit counter will reset./p>table>thead>tr>th>Header/th>th>Description/th>/tr>/thead>tbody>tr>td>code>X-RateLimit-Limit/code>/td>td>The maximum amount of requests you are allowed to send in the specified interval./td>/tr>tr>td>code>X-RateLimit-Remaining/code>/td>td>The amount of requests you can still make in the current interval before exceeding the limit./td>/tr>tr>td>code>X-RateLimit-Reset/code>/td>td>A unix timestamp indicating when the rate limit counter will reset to 0. Note that this header is only present when the rate limit has been exceeded./td>/tr>/tbody>/table>h1 idinteractions>Interactions/h1>blockquote>p>Interaction resources follow this example format in JSON/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>/span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>24062/span>span classp>,/span>span classw>/span>span classnl>uuid/span>span classp>:/span>span classw> /span>span classs2>7aa870f0-046f-11e7-9cc9-9de741d6e753/span>span classp>,/span>span classw>/span>span classnl>survey_id/span>span classp>:/span>span classw> /span>span classmi>493/span>span classp>,/span>span classw>/span>span classnl>phone_number/span>span classp>:/span>span classw> /span>span classs2>+61409999999/span>span classp>,/span>span classw>/span>span classnl>email/span>span classp>:/span>span classw> /span>span classs2>john.bloggs@example.com/span>span classp>,/span>span classw>/span>span classnl>survey_type/span>span classp>:/span>span classw> /span>span classs2>inbound/span>span classp>,/span>span classw>/span>span classnl>scheduled_at/span>span classp>:/span>span classw> /span>span classs2>2016-02-19 10:30:02/span>span classp>,/span>span classw>/span>span classnl>external_ref/span>span classp>:/span>span classw> /span>span classs2>example-id-235i129/span>span classp>,/span>span classw>/span>span classnl>updated_at/span>span classp>:/span>span classw> /span>span classs2>2016-02-19 10:30:02/span>span classp>,/span>span classw>/span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2016-02-19 10:30:02/span>span classp>,/span>span classw>/span>span classnl>call_type/span>span classp>:/span>span classw> /span>span classs2>support/span>span classp>,/span>span classw>/span>span classnl>agent_id/span>span classp>:/span>span classw> /span>span classs2>nevilr/span>span classp>,/span>span classw>/span>span classnl>status/span>span classp>:/span>span classw> /span>span classs2>Not Started/span>span classp>,/span>span classw>/span>span classnl>web_link/span>span classp>:/span>span classw> /span>span classs2>https://surveydynamix.com/web_survey/<uuid>/span>span classp>,/span>span classw>/span>span classnl>respondent_language/span>span classp>:/span>span classs2>en-AU/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>An interaction resource represents a request for a survey respondent to complete a specified survey. The status of all interactions with survey respondents are tracked by Mindful Feedback using the interaction resource.The interaction resource API is used to create new survey interactions, update existing interactions with new information, and view the status of existing interactions./p>p>strong>JSON object contains the following information:/strong>/p>table>thead>tr>th>Name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>id/code>/td>td>A unique interaction ID/td>/tr>tr>td>code>uuid/code>/td>td>A unique interaction UUID/td>/tr>tr>td>code>survey_id/code>/td>td>The ID of the survey that the interaction belongs to/td>/tr>tr>td>code>phone_number/code>/td>td>The contact phone number that will be used to perform outbound voice or SMS interactions/td>/tr>tr>td>code>email/code>/td>td>The email address of the survey respondent if the survey is a web survey distributed via email/td>/tr>tr>td>code>survey_type/code>/td>td>The medium by which the interaction will be performed./td>/tr>tr>td>code>scheduled_at/code>/td>td>A timestamp scheduling when the interaction should be performed by Mindful Feedback/td>/tr>tr>td>code>external_ref/code>/td>td>This is the reference used to link the survey interaction with the contact center interaction. Often this value is set to the contact center interaction ID./td>/tr>tr>td>code>call_type/code>/td>td>This is used to categorize survey interactions by the contact center call type. Often this value is set to the Queue Name/td>/tr>tr>td>code>agent_id/code>/td>td>The agent ID of a user in Mindful Feedback, used for report aggregation/td>/tr>tr>td>code>status/code>/td>td>A text field describing the current status of the interaction at point of retrieval. A list of statusus can be found below this table/td>/tr>tr>td>code>web_link/code>/td>td>Web link of the survey interaction./td>/tr>tr>td>code>weblink_short/code>/td>td>Short web link of the survey interaction./td>/tr>tr>td>code>unsubscribe_link_short/code>/td>td>Short URL to unsubscribe from Mindful Feedback surveys. Only available on SMS type surveys or when a short URL is explicitly requested when generating an interaction via API./td>/tr>tr>td>code>restricted/code>/td>td>Interaction was restricted (not sent). This could be due to a license restriction on your Mindful Feedback account, the respondent being in the Do Not Call list, or the interaction breaching a Survey Restriction./td>/tr>tr>td>code>respondent_language/code>/td>td>Language of the survey respondent. This is used to ensure the survey is played/displayed in the correct language./td>/tr>tr>td>code>updated_at/code>/td>td>Timestamps specifying when the interaction was last updated/td>/tr>tr>td>code>created_at/code>/td>td>Timestamps specifying when the interaction was created/td>/tr>tr>td>code>updatable/code>/td>td>Updatable is a value returned from the interactions API indicating whether or not this interaction can be updated. If the interaction has started, completed, ended or has a sent_at value, it cannot be updated. It return true for a created interaction that has not yet started, completed, ended or has a sent_at value/td>/tr>/tbody>/table>p>strong>code>status/code> values that can be returned/strong>/p>table>thead>tr>th>Description/th>/tr>/thead>tbody>tr>td>code>Sent to respondent <#> <minutes/hours/weeks/month> ago/code>/td>/tr>tr>td>code>Completed <#> <minutes/hours/weeks/month>ago/code>/td>/tr>tr>td>code>Abandoned <#> <minutes/hours/weeks/month> ago/code>/td>/tr>tr>td>code>Not started/code>/td>/tr>tr>td>code>In progress/code>/td>/tr>tr>td>code>Prevented due to survey restriction <#> <minutes/hours/weeks/month> ago/code>/td>/tr>/tbody>/table>h2 idget-interactions-list>Get Interactions List/h2>blockquote>p>This code will return 5 outbound interactions from the survey with ID  52:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/interactions?survey_id52&_limit5&survey_typeoutbound/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/interactions?survey_id52&_limit5&survey_typeoutbound/span>span classp>,/span>   span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>  span classnv>$username/span> span classo>/span> span classn>Customer_UUID/span>span classp>;/span>  span classnv>$password/span> span classo>/span> span classn>Auth_Token/span>span classp>;/span>  span classnv>$URL/span> span classo>/span> span classs2>https://surveydynamix.com/api/interactions?survey_id52&_limit5&survey_typeoutbound/span>span classp>;/span>  span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>  span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span>span classnv>$URL/span>span classp>);/span>  span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_TIMEOUT/span>span classp>,/span> span classmi>30/span>span classp>);/span> span classc1>//timeout after 30 seconds/span>  span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span>span classmi>1/span>span classp>);/span>  span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPAUTH/span>span classp>,/span> span classno>CURLAUTH_ANY/span>span classp>);/span>  span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs2>/span>span classnv>$username/span>span classs2>:/span>span classnv>$password/span>span classs2>/span>span classp>);/span>  span classnv>$result/span>span classo>/span>span classnb>curl_exec/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>  span classnv>$status_code/span> span classo>/span> span classnb>curl_getinfo/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLINFO_HTTP_CODE/span>span classp>);/span>   span classc1>//get status code/span>  span classnb>print_r/span>span classp>(/span>span classnv>$result/span>span classp>);/span>  span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span> /code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>  span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interactions?survey_id52&_limit5&survey_typeoutbound/span>span classdl>/span>span classp>;/span>  span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>  span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>  span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>  span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>    span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>        span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>        span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>    span classp>}};/span>  span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>p>Gets a list of survey interactions as a JSON array of interaction resources./p>h3 iduri>URI/h3>p>code>/interactions/code>/p>h3 idmethod>Method/h3>p>code>GET/code>/p>h3 idparameters>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>survey_id/code>/td>td>The ID of the survey the interactions belong to. Found on the top right of the relevant survey page./td>td>integer/td>td>none/td>/tr>tr>td>code>_limit/code>/td>td>The number of matching interactions to return./td>td>integer between 1 and 1000/td>td>10/td>/tr>tr>td>code>_offset/code>/td>td>The row number to start at if more than _limit interactions are found. There is an _offset limit of 300000./td>td>integer/td>td>0/td>/tr>tr>td>code>_order_by/code>/td>td>The interaction attribute to order the results by. This attribute only has an effect if the _order attribute is also set. If _order is not set, current interaction status will be used./td>td>'scheduled_at', 'completed_at', 'started_at', 'id'/td>td>'id'/td>/tr>tr>td>code>_order/code>/td>td>The order that results should be returned in./td>td>‘ASC’: earliest first or ‘DESC’: most recent first/td>td>Default order is by current interaction status./td>/tr>tr>td>code>_has_responses/code>/td>td>If true, only returns interactions that have at least one response. If false, only returns interactions with zero responses./td>td>boolean/td>td>NONE/td>/tr>tr>td>code>_include_responses/code>/td>td>Whether or not to include question responses in JSON. When true, response objects (see a href#responses>Responses/a>) will be appended in an array under the “responses” field./td>td>boolean/td>td>FALSE/td>/tr>tr>td>code>_include_data/code>/td>td>Whether or not to include interaction data in JSON. When true, interaction data objects (see a href#interaction-data>Interaction Data/a>) will be appended in an array under the “interaction_data” field./td>td>boolean/td>td>FALSE/td>/tr>tr>td>code>email/code>/td>td>The email address of the survey respondent, to be used in sending email type surveys./td>td>An email address/td>td>empty/td>/tr>tr>td>code>phone_number/code>/td>td>The phone number of the survey respondent, to be used in voice/sms type surveys./td>td>A 12 character string in the proper phone number format/td>td>empty/td>/tr>tr>td>code>survey_type/code>/td>td>The survey medium to use./td>td>inbound, outbound, sms, email, web, websms/td>td>none/td>/tr>tr>td>code>scheduled_at/code>/td>td>The time at which an outbound voice, sms,websms, or email survey is scheduled to be sent./td>td>dateTime/td>td>none/td>/tr>tr>td>code>external_ref/code>/td>td>A standard string field for referencing external system IDs. Single/Multiple values with comma seperated/td>td>string/td>td>none/td>/tr>tr>td>code>call_type/code>/td>td>A standard string field for report aggregation/td>td>string/td>td>none/td>/tr>tr>td>code>agent_id/code>/td>td>A string corresponding to an agent ID for report aggregation./td>td>string/td>td>none/td>/tr>tr>td>code>started/code>/td>td>Whether or not the interaction has started/td>td>boolean/td>td>none/td>/tr>tr>td>code>completed/code>/td>td>Whether or not the interaction has completed/td>td>boolean/td>td>none/td>/tr>tr>td>code>survey_ended/code>/td>td>Whether or not the survey was successfully completed within the interaction/td>td>boolean/td>td>none/td>/tr>tr>td>code>start_date/code>/td>td>Only return interactions scheduled for after the specified start date/td>td>Date/time string/td>td>none/td>/tr>tr>td>code>end_date/code>/td>td>Only return interactions scheduled for before the specified end date/td>td>Date/time string/td>td>none/td>/tr>tr>td>code>_updated_after/code>/td>td>Filter response to include interactions that were updated or created after the specified timestamp./td>td>UTC Timestamp (YYYY-MM-DD HH:mm:ss)/td>td>none/td>/tr>/tbody>/table>h2 idadd-new-interaction>Add New Interaction/h2>blockquote>p>This code will create an email interaction for respondent@example.com on survey with ID  52 to be sent in 5 minutes:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST   span classs2>https://surveydynamix.com/api/interactions/span> span classse>\/span>    span classnt>-d/span> span classs2>survey_id52/span> span classse>\/span>    span classnt>-d/span> span classs2>survey_typeemail/span> span classse>\/span>    span classnt>-d/span> span classs2>emailrespondent@example.com/span> span classse>\/span>    span classnt>-d/span> span classs2>scheduled_atNow + 5 minutes/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>  span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>  span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interactions/span>span classp>);/span>  span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>  span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POSTFIELDS/span>span classp>,/span> span classs2>survey_id52&survey_typeemail&emailrespondent@example.com&scheduled_atNow + 5 minutes/span>span classp>);/span>  span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POST/span>span classp>,/span> span classmi>1/span>span classp>);/span>  span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>  span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>  span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Content-Type: application/x-www-form-urlencoded/span>span classp>;/span>  span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>  span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>  span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>      span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>  span classp>}/span>  span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>  span classkn>import/span> span classnn>requests/span>  span classn>data/span> span classo>/span> span classs>survey_id52&survey_typeemail&emailrespondent@example.com&scheduled_atNow + 5 minutes/span>  span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/interactions/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>),/span> span classn>data/span>span classo>/span>span classn>data/span>span classp>)/span>  span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interactions/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>POST/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Type/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>application/x-www-form-urlencoded/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classkd>var/span> span classnx>data/span> span classo>/span> span classdl>/span>span classs2>survey_id52&survey_typeemail&emailrespondent@example.com&scheduled_atNow + 5 minutes/span>span classdl>/span>span classp>;/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre>/div>p>Creates a survey interaction with the specified parameters./p>h3 iduri-2>URI/h3>p>code>/interactions/code>/p>h3 idmethod-2>Method/h3>p>code>POST/code>/p>h3 idparameters-2>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>survey_id/code>/td>td>The ID of the survey you wish to add the interaction to. Found on the top right of the relevant survey page./td>td>integer/td>td>No default; Parameter required/td>/tr>tr>td>code>_force_new/code>/td>td>Force a new interaction to be added even if a pending interaction with the same phone number and survey ID exists./td>td>boolean/td>td>FALSE/td>/tr>tr>td>code>phone_number/code>/td>td>The phone number to be used in surveying. Required for voice and sms interactions./td>td>A 12 character string in the proper phone number format/td>td>empty/td>/tr>tr>td>code>phone_connection_id/code>/td>td>The ID of the phone connection you wish the interaction to use. Valid for voice/sms interactions./td>td>integer/td>td>empty/td>/tr>tr>td>code>email/code>/td>td>The email address of the survey respondent. Required for email interactions./td>td>An email address/td>td>empty/td>/tr>tr>td>code>survey_type/code>/td>td>The survey medium to use./td>td>inbound, outbound, sms, web, email, websms/td>td>web/td>/tr>tr>td>code>scheduled_at/code>/td>td>The time at which an outbound voice, sms, or email survey is scheduled to be sent. Or the time after which an inbound survey is allowed to start./td>td>dateTime string. Accepts times in standard UTC format and in the format “Now + X Days/Hours/Minutes”/td>td>now/td>/tr>tr>td>code>external_ref/code>/td>td>A standard string field for referencing external system IDs with single or multiple references./td>td>string/td>td>empty/td>/tr>tr>td>code>call_type/code>/td>td>A standard string field for report aggregation/td>td>string/td>td>empty/td>/tr>tr>td>code>agent_id/code>/td>td>A string corresponding to an agent ID. Will allow an agent user with this ID to see the interaction in the dashboard, and will be used to aggregate for agent rankings./td>td>string/td>td>empty/td>/tr>tr>td>code>respondent_language/code>/td>td>The specific language of the survey respondent. This is used to select survey prompts in multi-language surveys and to determine what language and dialect to use when automatically transcribing voice responses./td>td>see a href#supported-languages>Supported Languages/a>/td>td>determined by region/td>/tr>tr>td>code>_shorten_urls/code>/td>td>Generate a short URL for the start survey link and unsubscribe link./td>td>boolean/td>td>FALSE/td>/tr>tr>td>code>Custom Metadata/code>/td>td>parameters not otherwise listed in this table will be added as interaction data resources associated with the created interaction./td>td>The key must only include alphanumeric characters and underscores and must start with a letter. The value may be any string./td>td>none/td>/tr>/tbody>/table>aside classnotice> Interactions cannot be added if a pending interaction with the same phone number and survey id exists, unless the _force_new parameter is set to true. If you attempt to add an interaction like this, a 409(Conflict) response will be returned. /aside>h2 idget-specific-interaction-s>Get Specific Interaction(s)/h2>blockquote>p>This code will return a JSON object for the interaction resource with ID  891234:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/interactions/891234/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/interactions/891234/span>span classp>,/span>   span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interactions/891234/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interactions/891234/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>blockquote>p>This code will return JSON objects for the interaction resources with external_ref values of 891234 and 135900:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/interactions?external_ref891234,135900/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/interactions?external_ref891234,135900/span>span classp>,/span>   span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interactions?external_ref891234,135900/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interactions?external_ref891234,135900/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>p>Returns the JSON object for an interaction resource specified by either:br>- an code>{interaction_id}/code>br>- one or more code>{external_ref}/code> values, separated by commas/p>h3 iduri-3>URI/h3>p>code>/interactions/{interaction_id}/code>br>code>/interactions?external_ref{external_ref_1},{external_ref_2},...{external_ref_n}/code>/p>h3 idmethod-3>Method/h3>p>code>POST/code>/p>h3 idparameters-3>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>_include_responses/code>/td>td>Whether or not to include question responses in JSON. When true, response objects (see a href#responses>Responses/a>) will be appended in an array under the “responses” field./td>td>boolean/td>td>FALSE/td>/tr>tr>td>code>_include_data/code>/td>td>Whether or not to include interaction data in JSON. When true, interaction data objects (see a href#interaction-data>Interaction Data/a>) will be appended in an array under the “interaction_data” field./td>td>boolean/td>td>FALSE/td>/tr>/tbody>/table>h2 iddelete-interaction>Delete Interaction/h2>blockquote>p>This code will delete the interaction resource with ID  891234:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> DELETE   span classs2>https://surveydynamix.com/api/interactions/891234/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interactions/891234/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>DELETE/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>delete/span>span classp>(/span>span classs>https://surveydynamix.com/api/interactions/891234/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interactions/891234/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>DELETE/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic Auth_Token/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>p>Deletes an interaction resource specified by code>{interaction_id}/code>./p>h3 iduri-4>URI/h3>p>code>/interactions/{interaction_id}/code>/p>h3 idmethod-4>Method/h3>p>code>DELETE/code>/p>h3 idparameters-4>Parameters/h3>p>None/p>h2 idupdate-interaction>Update Interaction/h2>blockquote>p>This code will update the interaction resource with ID  891234 using a modified JSON object:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> PUT   span classs2>https://surveydynamix.com/api/interactions/891234/span> span classse>\/span>    span classnt>-d/span> span classs2>interaction{/span>span classse>\/span>span classs2>id/span>span classse>\/span>span classs2>:891234,/span>span classse>\/span>span classs2>survey_id/span>span classse>\/span>span classs2>:52,/span>span classse>\/span>span classs2>phone_number/span>span classse>\/span>span classs2>:/span>span classse>\\/span>span classs2>,/span>span classse>\/span>span classs2>survey_type/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>email/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>scheduled_at/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>2017-05-04 02:53:49/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>external_ref/span>span classse>\/span>span classs2>:/span>span classse>\\/span>span classs2>,/span>span classse>\/span>span classs2>created_at/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>2017-05-04 02:53:49/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>updated_at/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>2017-05-04 02:54:55/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>call_type/span>span classse>\/span>span classs2>:/span>span classse>\\/span>span classs2>,/span>span classse>\/span>span classs2>agent_id/span>span classse>\/span>span classs2>:/span>span classse>\\/span>span classs2>,/span>span classse>\/span>span classs2>uuid/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>e67fa4e0-3074-11e7-8efe-116b9b2f6833/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>email/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>rileyneville@gmail.com/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>status/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>Completed 1 hour ago/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>weblink/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>https:/span>span classse>\/\//span>span classs2>surveydynamix.com/span>span classse>\//span>span classs2>web_survey/span>span classse>\//span>span classs2>e67fa4e0-3074-11e7-8efe-116b9b2f6833/span>span classse>\/span>span classs2>}/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interactions/891234/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>PUT/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Type/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>application/x-www-form-urlencoded/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classkd>var/span> span classnx>data/span> span classo>/span> span classdl>/span>span classs1>interaction{id:891234,survey_id:52,phone_number:,survey_type:email,scheduled_at:2017-05-04 02:53:49,external_ref:,created_at:2017-05-04 02:53:49,updated_at:2017-05-04 02:54:55,call_type:,agent_id:,uuid:e67fa4e0-3074-11e7-8efe-116b9b2f6833,email:rileyneville@gmail.com,status:Completed 1 hour ago,weblink:https://surveydynamix.com/web_survey/e67fa4e0-3074-11e7-8efe-116b9b2f6833}/span>span classdl>/span>span classp>;/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>data/span> span classo>/span> span classs>interaction{id:891234,survey_id:52,phone_number:,survey_type:email,scheduled_at:2017-05-04 02:53:49,external_ref:,created_at:2017-05-04 02:53:49,updated_at:2017-05-04 02:54:55,call_type:,agent_id:,uuid:e67fa4e0-3074-11e7-8efe-116b9b2f6833,email:rileyneville@gmail.com,status:Completed 1 hour ago,weblink:https:\/\/surveydynamix.com\/web_survey\/e67fa4e0-3074-11e7-8efe-116b9b2f6833}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/interactions/891234/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>),/span> span classn>data/span>span classo>/span>span classn>data/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interactions/891234/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POSTFIELDS/span>span classp>,/span> span classs2>interaction{\/span>span classn>id/span>span classerr>\/span>span classs2>:891234,/span>span classse>\/span>span classs2>survey_id/span>span classse>\/span>span classs2>:52,/span>span classse>\/span>span classs2>phone_number/span>span classse>\/span>span classs2>:/span>span classse>\\/span>span classs2>,/span>span classse>\/span>span classs2>survey_type/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>email/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>scheduled_at/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>2017-05-04 02:53:49/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>external_ref/span>span classse>\/span>span classs2>:/span>span classse>\\/span>span classs2>,/span>span classse>\/span>span classs2>created_at/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>2017-05-04 02:53:49/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>updated_at/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>2017-05-04 02:54:55/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>call_type/span>span classse>\/span>span classs2>:/span>span classse>\\/span>span classs2>,/span>span classse>\/span>span classs2>agent_id/span>span classse>\/span>span classs2>:/span>span classse>\\/span>span classs2>,/span>span classse>\/span>span classs2>uuid/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>e67fa4e0-3074-11e7-8efe-116b9b2f6833/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>email/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>rileyneville@gmail.com/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>status/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>Completed 1 hour ago/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>weblink/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>https://surveydynamix.com/web_survey/e67fa4e0-3074-11e7-8efe-116b9b2f6833/span>span classse>\/span>span classs2>}/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>PUT/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Content-Type: application/x-www-form-urlencoded/span>span classp>;/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>p>Updates a specified interaction with new properties supplied in a JSON object./p>p>Note that the new JSON object must have the same ID as the resource you are attempting to update./p>h3 iduri-5>URI/h3>p>code>/interactions/{interaction_id}/code>/p>h3 idmethod-5>Method/h3>p>code>PUT/code>/p>h3 idparameters-5>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>interaction/code>/td>td>A JSON object representing the interaction in the same format as returned by get and create requests with the fields to update altered in text./td>td>JSON String/td>td>No default; Parameter required/td>/tr>/tbody>/table>h2 idget-responses-list-by-interaction>Get Responses List By Interaction/h2>blockquote>p>This code will return a list of survey response resources associated with the interaction resource with ID  891234:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/interactions/891234/responses/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interactions/891234/responses/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interactions/891234/responses/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/interactions/891234/responses/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Gets a list of survey responses for the requested interaction./p>p>This works the same as a GET call to the /responses resource with the interaction_id parameter set to code>{interaction_id}/code>`/p>h3 iduri-6>URI/h3>p>code>/interactions/{interaction_id}/responses/code>/p>h3 idmethod-6>Method/h3>p>code>GET/code>/p>h3 idparameters-6>Parameters/h3>p>See a href#get-responses-list>Get Responses List./a>/p>h2 idget-interaction-data-list-by-interaction>Get Interaction Data List By Interaction/h2>blockquote>p>This code will return a list of interaction data resources associated with the interaction resource with ID  891234:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/interactions/891234/interaction_data/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interactions/891234/interaction_data/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interactions/891234/interaction_data/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/interactions/891234/interaction_data/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Gets a list of interaction data for the requested interaction/p>p>This works the same as a GET  call to the /interaction_data resource with the interaction_id parameter set to code>{interaction_id}/code>/p>h3 iduri-7>URI/h3>p>code>/interactions/{interaction_id}/interaction_data/code>/p>h3 idmethod-7>Method/h3>p>code>GET/code>/p>h3 idparameters-7>Parameters/h3>p>See a href#get-interaction-data-list>Get Interaction Data List./a>/p>h2 idstart-survey>Start Survey/h2>blockquote>p>This code will start the survey for interaction with ID  891234/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST   span classs2>https://surveydynamix.com/api/interactions/891234/start_survey/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interactions/891234/start_survey/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>POST/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Length/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>0/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interactions/891234/start_survey/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POST/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/interactions/891234/start_survey/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>blockquote>p>The request will return a JSON object with the following example structure:/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classnl>prompts/span>span classp>:/span>span classw>     /span>span classs2>This is the first survey prompt text/span>span classp>,/span>span classw>     /span>span classs2>This is the second survey prompt text/span>span classp>,/span>span classw>     /span>span classerr>#/span>span classw> /span>span classerr>.../span>span classw>     /span>span classs2>This is the Nth survey prompt text/span>span classp>,,/span>span classw>  /span>span classnl>sound_files/span>span classp>:/span>span classw>     /span>span classs2>http://First_sound_file_url.mp3/span>span classp>,/span>span classw>     /span>span classs2>http://Second_sound_file_url.mp3/span>span classp>,/span>span classw>     /span>span classerr>#/span>span classw> /span>span classerr>.../span>span classw>     /span>span classs2>http://Nth_sound_file_url.mp3/span>span classp>,,/span>span classw>  /span>span classnl>survey_completed/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw>  /span>span classnl>current_question/span>span classp>:{/span>span classw>    /span>span classerr>#question/span>span classw> /span>span classerr>resource/span>span classw> /span>span classerr>object/span>span classw> /span>span classerr>for/span>span classw> /span>span classerr>current/span>span classw> /span>span classerr>question/span>span classw> /span>span classerr>if/span>span classw> /span>span classerr>survey_completed/span>span classw> /span>span classerr>/span>span classw> /span>span classmi>0/span>span classw>  /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Starts a web based survey (if not already started) and returns lists of the current survey prompts and sound files if relevant. Also returns details of current question if a question response is expected./p>h3 iduri-8>URI/h3>p>code>/interactions/{interaction_id}/start_survey/code>/p>h3 idmethod-8>Method/h3>p>code>POST/code>/p>h3 idparameters-8>Parameters/h3>p>None/p>h2 idsubmit-survey-response>Submit Survey Response/h2>blockquote>p>This code will submit the response "Yes" to the survey for interaction with ID  891234/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST   span classs2>https://surveydynamix.com/api/interactions/891234/submit_response/span> span classse>\/span>    span classnt>-d/span> span classs2>responseYes/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interactions/891234/submit_response/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>POST/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Type/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>application/x-www-form-urlencoded/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classkd>var/span> span classnx>data/span> span classo>/span> span classdl>/span>span classs2>responseYes/span>span classdl>/span>span classp>;/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interactions/891234/submit_response/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POSTFIELDS/span>span classp>,/span> span classs2>responseYes/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POST/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Content-Type: application/x-www-form-urlencoded/span>span classp>;/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>data/span> span classo>/span> span classs>responseYes/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/interactions/891234/submit_response/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>),/span>  span classn>data/span>span classo>/span>span classn>data/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>blockquote>p>The request will return a JSON object with the following example structure:/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classnl>prompts/span>span classp>:/span>span classw>     /span>span classs2>This is the first survey prompt text/span>span classp>,/span>span classw>     /span>span classs2>This is the second survey prompt text/span>span classp>,/span>span classw>     /span>span classerr>#/span>span classw> /span>span classerr>.../span>span classw>     /span>span classs2>This is the Nth survey prompt text/span>span classp>,,/span>span classw>  /span>span classnl>sound_files/span>span classp>:/span>span classw>     /span>span classs2>http://First_sound_file_url.mp3/span>span classp>,/span>span classw>     /span>span classs2>http://Second_sound_file_url.mp3/span>span classp>,/span>span classw>     /span>span classerr>#/span>span classw> /span>span classerr>.../span>span classw>     /span>span classs2>http://Nth_sound_file_url.mp3/span>span classp>,,/span>span classw>  /span>span classnl>survey_completed/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw>  /span>span classnl>current_question/span>span classp>:{/span>span classw>    /span>span classerr>#question/span>span classw> /span>span classerr>resource/span>span classw> /span>span classerr>object/span>span classw> /span>span classerr>for/span>span classw> /span>span classerr>current/span>span classw> /span>span classerr>question/span>span classw> /span>span classerr>if/span>span classw> /span>span classerr>survey_completed/span>span classw> /span>span classerr>/span>span classw> /span>span classmi>0/span>span classw>  /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Submits a response to the current survey question, evaluates the response, then returns lists of the current survey prompts and sound files if relevant. Also returns details of current question if a question response is expected. If the interaction has not yet started, this will redirect to the a href#start-survey>Start Survey/a> call instead./p>h3 iduri-9>URI/h3>p>code>/interactions/{interaction_id}/submit_response/code>/p>h3 idmethod-9>Method/h3>p>code>POST/code>/p>h3 idparameters-9>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>response/code>/td>td>The string response sent by the survey respondent./td>td>string or array (i.e code>0,1/code> if multichoice)/td>td>No default; Parameter required/td>/tr>/tbody>/table>h2 idabandon-survey>Abandon Survey/h2>blockquote>p>This code will finish the survey for interaction with ID  891234/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST   span classs2>https://surveydynamix.com/api/interactions/891234/abandon_survey/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interactions/891234/abandon_survey/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>POST/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Length/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>0/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interactions/891234/abandon_survey/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POST/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/interactions/891234/abandon_survey/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>),/span> span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>blockquote>p>The request will return a JSON object with the following example structure:/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classnl>prompts/span>span classp>:/span>span classw>     /span>span classs2>This is the first survey prompt text/span>span classp>,/span>span classw>     /span>span classs2>This is the second survey prompt text/span>span classp>,/span>span classw>     /span>span classerr>#/span>span classw> /span>span classerr>.../span>span classw>     /span>span classs2>This is the Nth survey prompt text/span>span classp>,,/span>span classw>  /span>span classnl>sound_files/span>span classp>:/span>span classw>     /span>span classs2>http://First_sound_file_url.mp3/span>span classp>,/span>span classw>     /span>span classs2>http://Second_sound_file_url.mp3/span>span classp>,/span>span classw>     /span>span classerr>#/span>span classw> /span>span classerr>.../span>span classw>     /span>span classs2>http://Nth_sound_file_url.mp3/span>span classp>,,/span>span classw>  /span>span classnl>survey_completed/span>span classp>:/span>span classw> /span>span classmi>1/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Abandons or completes a web based survey and returns lists of the current survey prompts and sound files if relevant./p>h3 iduri-10>URI/h3>p>code>/interactions/{interaction_id}/abandon_survey/code>/p>h3 idmethod-10>Method/h3>p>code>POST/code>/p>h3 idparameters-10>Parameters/h3>p>None/p>h1 idinteraction-data>Interaction Data/h1>blockquote>p>Interaction data resources follow this example format in JSON/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>/span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>12214125/span>span classp>,/span>span classw>/span>span classnl>interaction_id/span>span classp>:/span>span classw> /span>span classmi>24062/span>span classp>,/span>span classw>/span>span classnl>custom_key/span>span classp>:/span>span classw> /span>span classs2>VALUE/span>span classp>,/span>span classw>/span>span classnl>custom_value/span>span classp>:/span>span classw> /span>span classs2>GOLD/span>span classp>,/span>span classw>/span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2016-02-19 10:30:02/span>span classp>,/span>span classw>/span>span classnl>updated_at/span>span classp>:/span>span classw> /span>span classs2>2016-02-19 10:30:02/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>An interaction data resource details a custom key value pair associated with a specific survey interaction. These can be used to tag interactions with specific data for reporting purposes./p>p>The API can be used to retrieve lists of Interaction Data objects related to a specific interaction or survey./p>p>strong>JSON object contains the following information/strong>/p>table>thead>tr>th>Name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>id/code>/td>td>A unique interaction data ID./td>/tr>tr>td>code>interaction_id/code>/td>td>A unique ID for the interaction./td>/tr>tr>td>code>custom_key/code>/td>td>---/td>/tr>tr>td>code>custom_value/code>/td>td>---/td>/tr>tr>td>code>updated_at/code>/td>td>Timestamps specifying when the key value pair was last updated/td>/tr>tr>td>code>created_at/code>/td>td>Timestamps specifying when the key value pair was created/td>/tr>/tbody>/table>h2 idget-interaction-data-list>Get Interaction Data List/h2>blockquote>p>This code will return a JSON array of interaction data resources associated with the interaction resource with ID  891234:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/interaction_data?interaction_id891234/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/interaction_data?interaction_id891234/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interaction_data?interaction_id891234/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interaction_data?interaction_id891234/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>blockquote>p>This code will return a JSON array containing just the interaction data object with custom key  foo for the interaction resource with ID  891234:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/interaction_data?interaction_id891234&custom_keyfoo/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/interaction_data?interaction_id891234&custom_keyfoo/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interaction_data?interaction_id891234&custom_keyfoo/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interaction_data?interaction_id891234&custom_keyfoo/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>p>Gets a list of interaction data resources associated with a survey or interaction resource./p>h3 iduri>URI/h3>p>code>/interaction_data/code>/p>h3 idmethod>Method/h3>p>code>GET/code>/p>h3 idparameters>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>survey_id/code>/td>td>The ID of the survey resource the interaction data is associated with./td>td>integer/td>td>none/td>/tr>tr>td>code>interaction_id/code>/td>td>The ID of the interaction resource the interaction data is associated with./td>td>integer/td>td>none/td>/tr>tr>td>code>_limit/code>/td>td>The number of matching interaction data resources to return./td>td>integer between 1 and 1000/td>td>10/td>/tr>tr>td>code>_offset/code>/td>td>The row number to start at if more than _limit interaction data resources are found. There is an _offset limit of 300000./td>td>integer/td>td>0/td>/tr>tr>td>code>_order/code>/td>td>The order that results should be returned in./td>td>‘ASC’: earliest first/td>td>DESC/td>/tr>tr>td>/td>td>/td>td>or ‘DESC’: most recent first/td>td>/td>/tr>tr>td>code>_order_by/code>/td>td>The attribute to order the results by./td>td>'id','custom_value','custom_key'/td>td>'id'/td>/tr>tr>td>code>custom_key/code>/td>td>The custom key of the interaction data./td>td>A string consisting only of alphanumeric characters and underscores and starting with a letter/td>td>none/td>/tr>/tbody>/table>h2 idget-specific-interaction-data>Get Specific Interaction Data/h2>blockquote>p>This code will return a JSON object for the interaction data resource with ID  12214125:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/interaction_data/12214125/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/interaction_data/12214125/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interaction_data/12214125/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interaction_data/12214125/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>p>Returns the JSON object for an interaction data resource specified by code>{interaction_data_id}/code>./p>h3 iduri-2>URI/h3>p>code>/interaction_data/{interaction_data_id}/code>/p>h3 idmethod-2>Method/h3>p>code>GET/code>/p>h3 idparameters-2>Parameters/h3>p>None/p>h2 idset-interaction-data>Set Interaction Data/h2>blockquote>p>This code will add the custom key value pair foobar to the interaction resource with ID  891234:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST   span classs2>https://surveydynamix.com/api/interaction_data/span> span classse>\/span>    span classnt>-d/span> span classs2>interaction_id891234/span> span classse>\/span>    span classnt>-d/span> span classs2>custom_keyfoo/span> span classse>\/span>    span classnt>-d/span> span classs2>custom_valuebar/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>data/span> span classo>/span> span classs>interaction_id891234&custom_keyfoo&custom_valuebar/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/interaction_data/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>),/span> span classn>data/span>span classo>/span>span classn>data/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interaction_data/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POSTFIELDS/span>span classp>,/span> span classs2>interaction_id891234&custom_keyfoo&custom_valuebar/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POST/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Content-Type: application/x-www-form-urlencoded/span>span classp>;/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interaction_data/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>POST/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Type/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>application/x-www-form-urlencoded/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classkd>var/span> span classnx>data/span> span classo>/span> span classdl>/span>span classs2>interaction_id891234&custom_keyfoo&custom_valuebar/span>span classdl>/span>span classp>;/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre>/div>blockquote>p>This code will update the existing custom key value pair to foobaz:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST   span classs2>https://surveydynamix.com/api/interaction_data/span> span classse>\/span>    span classnt>-d/span> span classs2>interaction_id891234/span> span classse>\/span>    span classnt>-d/span> span classs2>custom_keyfoo/span> span classse>\/span>    span classnt>-d/span> span classs2>custom_valuebaz/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>data/span> span classo>/span> span classs>interaction_id891234&custom_keyfoo&custom_valuebaz/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/interaction_data/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>),/span> span classn>data/span>span classo>/span>span classn>data/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interaction_data/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POSTFIELDS/span>span classp>,/span> span classs2>interaction_id891234&custom_keyfoo&custom_valuebaz/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POST/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Content-Type: application/x-www-form-urlencoded/span>span classp>;/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interaction_data/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>POST/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Type/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>application/x-www-form-urlencoded/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classkd>var/span> span classnx>data/span> span classo>/span> span classdl>/span>span classs2>interaction_id891234&custom_keyfoo&custom_valuebaz/span>span classdl>/span>span classp>;/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre>/div>p>Adds a custom key value pair associated with a specified interaction./p>p>If the custom key already exists for that interaction, it is overwritten with the new value./p>p>The updated interaction data JSON object will be returned./p>h3 iduri-3>URI/h3>p>code>/interaction_data/code>/p>h3 idmethod-3>Method/h3>p>code>POST/code>/p>h3 idparameters-3>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>interaction_id/code>/td>td>The ID of the interaction resource the interaction data is associated with./td>td>integer/td>td>No default; Parameter required/td>/tr>tr>td>code>custom_key/code>/td>td>The custom key of the interaction data./td>td>A string consisting only of alphanumeric characters and underscores and starting with a letter/td>td>No default; Parameter required/td>/tr>tr>td>code>custom_value/code>/td>td>The custom value of the interaction data./td>td>string/td>td>No default; Parameter required/td>/tr>/tbody>/table>h2 iddelete-interaction-data>Delete Interaction Data/h2>blockquote>p>This code will delete the interaction data resource with ID  12214125:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> DELETE   span classs2>https://surveydynamix.com/api/interaction_data/12214125/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>delete/span>span classp>(/span>span classs>https://surveydynamix.com/api/interaction_data/12214125/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/interaction_data/12214125/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>DELETE/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/interaction_data/12214125/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>DELETE/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>p>Deletes an interaction data resource specified by code>{interaction_data_id}/code>./p>h3 iduri-4>URI/h3>p>code>/interaction_data/{interaction_data_id}/code>/p>h3 idmethod-4>Method/h3>p>code>DELETE/code>/p>h3 idparameters-4>Parameters/h3>p>None/p>h1 idresponses>Responses/h1>blockquote>p>Response resources follow this example format in JSON/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>/span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>124890182/span>span classp>,/span>span classw>/span>span classnl>interaction_id/span>span classp>:/span>span classw> /span>span classmi>24062/span>span classp>,/span>span classw>/span>span classnl>question_id/span>span classp>:/span>span classw> /span>span classmi>879/span>span classp>,/span>span classw>/span>span classnl>response/span>span classp>:/span>span classw> /span>span classs2>Lorem Ipsum dolor sit./span>span classp>,/span>span classw>/span>span classnl>submitted_at/span>span classp>:/span>span classw> /span>span classs2>2016-02-19 10:30:02/span>span classp>,/span>span classw>/span>span classnl>recording_url/span>span classp>:/span>span classw> /span>span classs2><Twilio Voice Recording URL>/span>span classp>,/span>span classw>/span>span classnl>response_type/span>span classp>:/span>span classw> /span>span classs2>text/span>span classp>,/span>span classw>/span>span classnl>question_label/span>span classp>:/span>span classw> /span>span classs2><Question label for reporting use>/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>A response resource details the response given by a survey respondent to a question during an interaction. The complete results of a survey interaction are represented by a list of survey response objects for each question in the survey./p>p>The response resource API is used to retrieve detailed survey results from Mindful Feedback and can be queried by survey, question, or specific interaction./p>p>strong>JSON object contains the following information/strong>/p>table>thead>tr>th>Name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>id/code>/td>td>A unique Response ID./td>/tr>tr>td>code>interaction_id/code>/td>td>A unique ID for the interaction./td>/tr>tr>td>code>question_id/code>/td>td>A unique ID for the question/td>/tr>tr>td>code>question_label/code>/td>td>Question label for reporting use/td>/tr>tr>td>code>response/code>/td>td>A string containing response given by the survey respondent/td>/tr>tr>td>code>response_type/code>/td>td>the type of response it was (code>text/code>, code>yesno/code>, code>nps/code>, code>number/code>, or code>multichoice/code>)/td>/tr>tr>td>code>recording_url/code>/td>td>URL/link to the Twilio voice recording./td>/tr>tr>td>code>submitted_at/code>/td>td>Timestamps specifying when the response was submitted/td>/tr>/tbody>/table>aside classnotice > Response resources are read only. /aside>h2 idget-responses-list>Get Responses List/h2>blockquote>p>This code will return a JSON array of the most recent 100 response resources associated with the survey resource with ID  52:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/responses?survey_id52&_limit100&_orderDESC/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/responses?survey_id52&_limit100&_orderDESC/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/responses?survey_id52&_limit100&_orderDESC/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/responses?survey_id52&_limit100&_orderDESC/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Gets a list of survey responses associated with a survey, question, or interaction resource./p>h3 iduri>URI/h3>p>code>/responses/code>/p>h3 idmethod>Method/h3>p>code>GET/code>/p>h3 idparameters>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>survey_id/code>/td>td>The ID of the survey resource the responses is associated with./td>td>integer/td>td>none/td>/tr>tr>td>code>question_id/code>/td>td>The ID of the question resource the responses is associated with./td>td>integer/td>td>none/td>/tr>tr>td>code>interaction_id/code>/td>td>The ID of the interaction resource the responses is associated with./td>td>integer/td>td>none/td>/tr>tr>td>code>_limit/code>/td>td>The number of matching responses to return./td>td>integer between 1 and 1000/td>td>10/td>/tr>tr>td>code>_offset/code>/td>td>The row number to start at if more than _limit responses are found. There is an _offset limit of 300000./td>td>integer/td>td>0/td>/tr>tr>td>code>_order_by/code>/td>td>The attribute to order the results by./td>td>'submitted_at','id'/td>td>'id'/td>/tr>tr>td>code>_order/code>/td>td>The order that results should be returned in./td>td>‘ASC’: earliest first/td>td>DESC/td>/tr>tr>td>/td>td>/td>td>or ‘DESC’: most recent first/td>td>/td>/tr>tr>td>code>response/code>/td>td>Filters results to only where the response exactly equals this string./td>td>string/td>td>none/td>/tr>tr>td>code>response_contains/code>/td>td>Filters results to where the response contains this string/td>td>string/td>td>none/td>/tr>tr>td>code>start_date/code>/td>td>Only return responses submitted after the specified start date/td>td>Date/time string/td>td>none/td>/tr>tr>td>code>end_date/code>/td>td>Only return responses submitted before the specified end date/td>td>Date/time string/td>td>none/td>/tr>/tbody>/table>h2 idget-specific-response>Get Specific Response/h2>blockquote>p>This code will return a JSON object for the response resource with ID  124890182:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/responses/124890182/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/responses/124890182/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/responses/124890182/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/responses/124890182/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Returns the JSON object for a response resource specified by code>{response_id}/code>./p>h3 iduri-2>URI/h3>p>code>/responses/{response_id}/code>/p>h3 idmethod-2>Method/h3>p>code>GET/code>/p>h3 idparameters-2>Parameters/h3>p>None/p>h1 idsurveys>Surveys/h1>blockquote>p>Survey resources follow this example format in JSON/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>52/span>span classp>,/span>span classw>  /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Test survey/span>span classp>,/span>span classw>  /span>span classnl>description/span>span classp>:/span>span classw> /span>span classs2>Test survey for development/span>span classp>,/span>span classw>  /span>span classnl>email_from_address/span>span classp>:/span>span classw> /span>span classs2>test@surveydynamix.com/span>span classp>,/span>span classw>  /span>span classnl>email_from_name/span>span classp>:/span>span classw> /span>span classs2>Mindful Feedback API/span>span classp>,/span>span classw>  /span>span classnl>email_subject_prompt/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classnl>text/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>          /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2>Test email survey/span>span classw>      /span>span classp>}/span>span classw>  /span>span classp>},/span>span classw>  /span>span classnl>greeting_prompt/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classnl>text/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>          /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2>Thanks for taking the time to respond to our survey!/span>span classw>      /span>span classp>},/span>span classw>      /span>span classnl>sound_files/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>          /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2><sound file url>.mp3/span>span classw>      /span>span classp>}/span>span classw>  /span>span classp>},/span>span classw>  /span>span classnl>instructions_prompt/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classnl>text/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>          /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2>Wed love to get some feedback on your recent customer experience!/span>span classw>      /span>span classp>},/span>span classw>      /span>span classnl>sound_files/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>          /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2><sound file url>.mp3/span>span classw>      /span>span classp>}/span>span classw>  /span>span classp>},/span>span classw>  /span>span classnl>closing_prompt/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classnl>text/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>          /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2>Thank you for participating. Goodbye./span>span classw>      /span>span classp>},/span>span classw>      /span>span classnl>sound_files/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>          /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2><sound file url>.mp3/span>span classw>      /span>span classp>}/span>span classw>  /span>span classp>},/span>span classw>  /span>span classnl>invalid_response_prompt/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classnl>text/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>          /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>      /span>span classp>}/span>span classw>  /span>span classp>},/span>span classw>  /span>span classnl>inbound_number/span>span classp>:/span>span classw> /span>span classs2>+61999999999/span>span classp>,/span>span classw>  /span>span classnl>outbound_number/span>span classp>:/span>span classw> /span>span classs2>+61999999999/span>span classp>,/span>span classw>  /span>span classnl>sms_number/span>span classp>:/span>span classw> /span>span classs2>+61888888888/span>span classp>,/span>span classw>  /span>span classnl>rediect_timeout/span>span classp>:/span>span classw> /span>span classs2>3200/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>A survey resource details the core properties of a survey within SDX./p>p>The survey query API can be used to get detailed information about a survey for third party reporting or API response submission/p>p>strong>JSON object contains the following information/strong>/p>table>thead>tr>th>Name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>id/code>/td>td>A unique survey ID./td>/tr>tr>td>code>name/code>/td>td>The name of the survey./td>/tr>tr>td>code>description/code>/td>td>Description of the survey/td>/tr>tr>td>code>email_from_address/code>/td>td>Email from details/td>/tr>tr>td>code>email_from_name/code>/td>td>Email name details/td>/tr>tr>td>code>email_subject_prompt/code>/td>td>Email subject a href#survey-text-prompts>text prompt/a>/td>/tr>tr>td>code>greeting_prompt/code>/td>td>Greeting a href#survey-prompts>prompts/a>/td>/tr>tr>td>code>instructions_prompt/code>/td>td>Instructions a href#survey-prompts>prompts/a>/td>/tr>tr>td>code>closing_prompt/code>/td>td>Closing a href#survey-prompts>prompts/a>/td>/tr>tr>td>code>invalid_response_prompt/code>/td>td>The invalid response a href#survey-prompts>prompt/a>/td>/tr>tr>td>code>inbound_number/code>/td>td>Voice connection number for inbound/td>/tr>tr>td>code>outbound_number/code>/td>td>Voice connection number for outbound/td>/tr>tr>td>code>sms_number/code>/td>td>SMS connection number for SMS/td>/tr>tr>td>code>redirect_timeout/code>/td>td>---/td>/tr>/tbody>/table>aside classnotice> Survey resources are read only. /aside>h2 idget-surveys-list>Get Surveys List/h2>blockquote>p>This code will return a JSON array of all survey resources associated with the authenticated customer:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/surveys?_limit1000/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/surveys?_limit1000/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/surveys?_limit1000/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/surveys?_limit1000/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>p>Gets a list of survey resources associated with the authenticated customer./p>h3 iduri>URI/h3>p>code>/surveys/code>/p>h3 idmethod>Method/h3>p>code>GET/code>/p>h3 idparameters>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>_limit/code>/td>td>The number of matching results to return./td>td>integer between 1 and 1000/td>td>10/td>/tr>tr>td>code>_offset/code>/td>td>The row number to start at if more than _limit results are found. There is an _offset limit of 300000./td>td>integer/td>td>0/td>/tr>tr>td>code>_order/code>/td>td>The order of ID that results should be returned in./td>td>‘ASC’: earliest first/td>td>DESC/td>/tr>tr>td>/td>td>/td>td>or ‘DESC’: most recent first/td>td>/td>/tr>/tbody>/table>h2 idget-specific-survey>Get Specific Survey/h2>blockquote>p>This code will return a JSON object for the survey resource with ID  52:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/surveys/52/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/surveys/52/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/surveys/52/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/surveys/52/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Returns the JSON object for a survey resource specified by code>{survey_id}/code>./p>h3 iduri-2>URI/h3>p>code>/surveys/{survey_id}/code>/p>h3 idmethod-2>Method/h3>p>code>GET/code>/p>h3 idparameters-2>Parameters/h3>p>None/p>h2 idget-questions-list-by-survey>Get Questions List By Survey/h2>blockquote>p>This code will return a JSON array of question resources that are part of the survey resource with ID  52:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/surveys/52/questions/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/surveys/52/questions/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/surveys/52/questions/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/surveys/52/questions/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Gets a list of questions that are part of the requested survey./p>p>This works the same as a GET call to the /questions resource with the code>survey_id/code> parameter set to code>{survey_id}/code>/p>h3 iduri-3>URI/h3>p>code>/surveys/{survey_id}/questions/code>/p>p>code>GET/code>/p>h3 idparameters-3>Parameters/h3>p>See a href#get-questions-list>Get Questions List/a>/p>h2 idget-interactions-list-by-survey>Get Interactions List By Survey/h2>blockquote>p>This code will return a JSON array of interaction resources that are associated with the survey resource with ID  52:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/surveys/52/interactions/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/surveys/52/interactions/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/surveys/52/interactions/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/surveys/52/interactions/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Gets a list of interactions that are associated with the requested survey./p>p>This works the same as a GET call to the /interactions resource with the code>survey_id/code> parameter set to code>{survey_id}/code>/p>h3 iduri-4>URI/h3>p>code>/surveys/{survey_id}/interactions/code>/p>p>code>GET/code>/p>h3 idparameters-4>Parameters/h3>p>See a href#get-interactions-list>Get Interactions List/a>/p>h2 idget-interaction-data-list-by-survey>Get Interaction Data List By Survey/h2>blockquote>p>This code will return a JSON array of interaction data resources that are associated with the survey resource with ID  52:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/surveys/52/interaction_data/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/surveys/52/interaction_data/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/surveys/52/interaction_data/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/surveys/52/interaction_data/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Gets a list of interaction data resources that associated with of the requested survey./p>p>This works the same as a GET call to the /interaction_data resource with the code>survey_id/code> parameter set to code>{survey_id}/code>/p>h3 iduri-5>URI/h3>p>code>/surveys/{survey_id}/interaction_data/code>/p>p>code>GET/code>/p>h3 idparameters-5>Parameters/h3>p>See a href#get-interaction-data-list>Get Interaction Data List/a>/p>h2 idget-responses-list-by-survey>Get Responses List By Survey/h2>blockquote>p>This code will return a JSON array of response resources that are associated with the survey resource with ID  52:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/surveys/52/responses/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/surveys/52/responses/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/surveys/52/responses/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/surveys/52/responses/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>p>Gets a list of responses that are associated with the requested survey./p>p>This works the same as a GET call to the /responses resource with the code>survey_id/code> parameter set to code>{survey_id}/code>/p>h3 iduri-6>URI/h3>p>code>/surveys/{survey_id}/responses/code>/p>p>code>GET/code>/p>h3 idparameters-6>Parameters/h3>p>See a href#get-responses-list>Get Responses List/a>/p>h1 idquestions>Questions/h1>blockquote>p>Question resources follow this example format in JSON/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>509/span>span classp>,/span>span classw>    /span>span classnl>survey_id/span>span classp>:/span>span classw> /span>span classmi>71/span>span classp>,/span>span classw>    /span>span classnl>order/span>span classp>:/span>span classw> /span>span classmi>2/span>span classp>,/span>span classw>    /span>span classnl>max_response/span>span classp>:/span>span classw> /span>span classmi>1/span>span classp>,/span>span classw>    /span>span classnl>question_type/span>span classp>:/span>span classw> /span>span classs2>multichoice/span>span classp>,/span>span classw>    /span>span classnl>question_label/span>span classp>:/span>span classw> /span>span classs2>Multiple Choice Question/span>span classp>,/span>span classw>    /span>span classnl>question_prompt/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classnl>text/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2>What is your favourite letter?/span>span classp>,/span>span classw>        /span>span classp>},/span>span classw>        /span>span classnl>sound_files/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                    /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2><sound file url>.mp3/span>span classp>,/span>span classw>        /span>span classp>}/span>span classw>    /span>span classp>},/span>span classw>    /span>span classnl>scale_label_min_prompt/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classnl>text/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>        /span>span classp>}/span>span classw>    /span>span classp>},/span>span classw>    /span>span classnl>scale_label_mid_prompt/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classnl>text/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>        /span>span classp>}/span>span classw>    /span>span classp>},/span>span classw>    /span>span classnl>scale_label_max_prompt/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>        /span>span classnl>text/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>            /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2>/span>span classw>        /span>span classp>}/span>span classw>    /span>span classp>},/span>span classw>    /span>span classnl>response_options/span>span classp>:/span>span classw> /span>span classp>/span>span classw>        /span>span classp>{/span>span classw>            /span>span classnl>label/span>span classp>:/span>span classw> /span>span classs2>a/span>span classp>,/span>span classw>            /span>span classnl>prompt/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classnl>text/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                    /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2>A/span>span classw>                /span>span classp>}/span>span classw>            /span>span classp>}/span>span classw>        /span>span classp>},/span>span classw>        /span>span classp>{/span>span classw>            /span>span classnl>label/span>span classp>:/span>span classw> /span>span classs2>b/span>span classp>,/span>span classw>            /span>span classnl>prompt/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classnl>text/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                    /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2>B/span>span classw>                /span>span classp>}/span>span classw>            /span>span classp>}/span>span classw>        /span>span classp>},/span>span classw>        /span>span classp>{/span>span classw>            /span>span classnl>label/span>span classp>:/span>span classw> /span>span classs2>c/span>span classp>,/span>span classw>            /span>span classnl>prompt/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                /span>span classnl>text/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>                    /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2>C/span>span classw>                /span>span classp>}/span>span classw>            /span>span classp>}/span>span classw>        /span>span classp>}/span>span classw>    /span>span classp>,/span>span classw>    /span>span classnl>compulsory/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw>    /span>span classnl>agent_score/span>span classp>:/span>span classw> /span>span classmi>0/span>span classp>,/span>span classw>    /span>span classnl>transcribe/span>span classp>:/span>span classw> /span>span classmi>1/span>span classw>  /span>span classp>}/span>span classw>/span>/code>/pre>/div>p>A question resource details the core properties of a question to be asked in an SDX survey./p>p>The question query API can be used to get detailed information about a questions for third party reporting or API response submission/p>p>strong>JSON object contains the following information/strong>/p>table>thead>tr>th>Name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>id/code>/td>td>A unique question ID./td>/tr>tr>td>code>survey_id/code>/td>td>If queried for a particular survey, the survey id and question order within the survey./td>/tr>tr>td>code>order/code>/td>td>Order of the question./td>/tr>tr>td>code>max_response/code>/td>td>MAx amount of responses./td>/tr>tr>td>code>question_type/code>/td>td>Type of question (code>text/code>, code>yesno/code>, code>nps/code>, code>number/code>, or code>multichoice/code>))/td>/tr>tr>td>code>question_label/code>/td>td>Label used for reporting/td>/tr>tr>td>code>question_prompt/code>/td>td>Question a href#survey-prompts>prompt/a> object/td>/tr>tr>td>code>scale_label_min_prompt/code>/td>td>The minimum scale label which is a a href#survey-text-prompts>text prompt/a> object/td>/tr>tr>td>code>scale_label_mid_prompt/code>/td>td>The medium scale label which is a a href#survey-text-prompts>text prompt/a> object/td>/tr>tr>td>code>scale_label_max_prompt/code>/td>td>The maximum scale label which is a a href#survey-text-prompts>text prompt/a> object/td>/tr>tr>td>code>response_options/code>/td>td>The response options, including a label and a href#survey-text-prompts>text prompt/a> for each response option. This field is null when the question type is not multichoice./td>/tr>tr>td>code>compulsory/code>/td>td>boolean indicating whether or not the question is considered compulsory./td>/tr>tr>td>code>agent_score/code>/td>td>boolean indicating whether or not the responses to the question will affect agent scores./td>/tr>tr>td>code>transcribe/code>/td>td>boolean indicating whether question responses should automatically be transcribed for text responses given over a voice channel./td>/tr>/tbody>/table>aside classnotice> Question resources are read only. /aside>h2 idget-questions-list>Get Questions List/h2>blockquote>p>This code will return a JSON array of all question resources part of the survey with id  52 :/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/questions?survey_id52/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/questions?survey_id52/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/questions?survey_id52/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/questions?survey_id52/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Gets a list of question resources associated with the authenticated customer./p>p>Can be queried by survey id, question type, or question label./p>h3 iduri>URI/h3>p>code>/questions/code>/p>h3 idmethod>Method/h3>p>code>GET/code>/p>h3 idparameters>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>_limit/code>/td>td>The number of matching results to return./td>td>integer between 1 and 1000/td>td>10/td>/tr>tr>td>code>_offset/code>/td>td>The row number to start at if more than _limit results are found. There is an _offset limit of 300000./td>td>integer/td>td>0/td>/tr>tr>td>code>_order/code>/td>td>The order of ID that results should be returned in./td>td>‘ASC’: earliest first/td>td>DESC/td>/tr>tr>td>/td>td>/td>td>or ‘DESC’: most recent first/td>td>/td>/tr>tr>td>code>survey_id/code>/td>td>The ID of the survey resource question is associated with./td>td>integer/td>td>none/td>/tr>tr>td>code>question_type/code>/td>td>The type of question./td>td>number, yesno, text, nps, multichoice/td>td>none/td>/tr>tr>td>code>question_label/code>/td>td>The reporting label of the question./td>td>string up to 30 characters long/td>td>none/td>/tr>/tbody>/table>h2 idget-specific-question>Get Specific Question/h2>blockquote>p>This code will return a JSON object for the question resource with ID  509:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/questions/509/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/questions/509/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/questions/509/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/questions/509/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Returns the JSON object for a question resource specified by code>{question_id}/code>./p>h3 iduri-2>URI/h3>p>code>/questions/{question_id}/code>/p>h3 idmethod-2>Method/h3>p>code>GET/code>/p>h3 idparameters-2>Parameters/h3>p>None/p>h2 idget-responses-list-by-question>Get Responses List By Question/h2>blockquote>p>This code will return a JSON array of responses associated with the question resource with ID  509:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/questions/509/responses/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/questions/509/responses/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/questions/509/responses/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/questions/509/responses/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Gets a list of responses to the requested question./p>p>This works the same as a GET call to the /responses resource with the code>question_id/code> parameter set to code>{question_id}/code>/p>h3 iduri-3>URI/h3>p>code>/questions/{question_id}/responses/code>/p>p>code>GET/code>/p>h3 idparameters-3>Parameters/h3>p>See a href#get-responses-list>Get Responses List/a>/p>h1 idusers>Users/h1>blockquote>p>User resources follow this example format in JSON/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>4064/span>span classp>,/span>span classw>    /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>Joe Smith/span>span classp>,/span>span classw>    /span>span classnl>email/span>span classp>:/span>span classw> /span>span classs2>joesmith@example.com/span>span classp>,/span>span classw>    /span>span classnl>agent_id/span>span classp>:/span>span classw> /span>span classs2>jSmith1/span>span classp>,/span>span classw>    /span>span classnl>phone/span>span classp>:/span>span classw> /span>span classs2>+61499999999/span>span classp>,/span>span classw>    /span>span classnl>timezone/span>span classp>:/span>span classw> /span>span classs2>Australia/Brisbane/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>A user resource details the core properties of a Mindful Feedback user./p>p>The users query API can be used to get detailed information about users for third party reporting or API interaction creation./p>p>strong>JSON object contains the following information/strong>/p>table>thead>tr>th>Name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>id/code>/td>td>A unique user ID./td>/tr>tr>td>code>name/code>/td>td>The user's name/td>/tr>tr>td>code>email/code>/td>td>email address which serves as their unique identifier./td>/tr>tr>td>code>agent_id/code>/td>td>The user’s agent ID./td>/tr>tr>td>code>phone/code>/td>td>The user's phone number/td>/tr>tr>td>code>timezone/code>/td>td>The user's timzone/td>/tr>/tbody>/table>aside classnotice> User resources are read only. /aside>h2 idget-users-list>Get Users List/h2>blockquote>p>This code will return a JSON array of all users with "Joe" in their name associated with the authenticated customer:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/users?_limit1000&name_containsJoe/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/users?_limit1000&name_containsJoe/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/users?_limit1000&name_containsJoe/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/users?_limit1000&name_containsJoe/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Gets a list of user resources associated with the authenticated customer./p>h3 iduri>URI/h3>p>code>/users/code>/p>h3 idmethod>Method/h3>p>code>GET/code>/p>h3 idparameters>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>_limit/code>/td>td>The number of matching results to return./td>td>integer between 1 and 1000/td>td>10/td>/tr>tr>td>code>_offset/code>/td>td>The row number to start at if more than _limit results are found. There is an _offset limit of 300000./td>td>integer/td>td>0/td>/tr>tr>td>code>_order/code>/td>td>The order of ID that results should be returned in./td>td>‘ASC’: earliest first/td>td>DESC/td>/tr>tr>td>/td>td>/td>td>or ‘DESC’: most recent first/td>td>/td>/tr>tr>td>code>name/code>/td>td>The exact name of the user you want to find/td>td>string/td>td>none/td>/tr>tr>td>code>name_contains/code>/td>td>Part of the name of the user you want to find/td>td>string/td>td>none/td>/tr>tr>td>code>agent_id/code>/td>td>The agent ID of the user you want to find/td>td>string/td>td>none/td>/tr>tr>td>code>phone/code>/td>td>The phone number of the user you want to find/td>td>string/td>td>none/td>/tr>tr>td>code>email/code>/td>td>The email address of the user you want to find/td>td>string/td>td>none/td>/tr>/tbody>/table>h2 idget-specific-user>Get Specific User/h2>blockquote>p>This code will return a JSON object for the user with the email address joesmith@example.com:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/users/joesmith@example.com/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/users/joesmith@example.com/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/users/joesmith@example.com/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/users/joesmith@example.com/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>p>Returns the JSON object for a user resource specified by code>{email_address}/code>./p>h3 iduri-2>URI/h3>p>code>/users/{email_address}/code>/p>h3 idmethod-2>Method/h3>p>code>GET/code>/p>h3 idparameters-2>Parameters/h3>p>None/p>h2 idget-interactions-list-by-user>Get Interactions List By User/h2>blockquote>p>This code will return a JSON array of interaction resources associated with the user with email address joesmith@example.com:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/users/joesmith@example.com/interactions/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/users/joesmith@example.com/interactions/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/users/joesmith@example.com/interactions/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/users/joesmith@example.com/interactions/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>p>Gets a list of interactions associated with a user by agent id/p>p>This works the same as a GET call to the /interactions resource with the code>agent_id/code> parameter set to the selected user’s agent ID./p>h3 iduri-3>URI/h3>p>code>/users/{email_address}/interactions/code>/p>p>code>GET/code>/p>h3 idparameters-3>Parameters/h3>p>See a href#get-interactions-list>Get Interactions List/a>/p>h1 iduser-groups>User Groups/h1>blockquote>p>User Group resources follow this example format in JSON/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classnl>id/span>span classp>:/span>span classw> /span>span classmi>24062/span>span classp>,/span>span classw>    /span>span classnl>name/span>span classp>:/span>span classw> /span>span classs2>My User Group/span>span classp>,/span>span classw>    /span>span classnl>updated_at/span>span classp>:/span>span classw> /span>span classs2>2016-02-19 10:30:02/span>span classp>,/span>span classw>    /span>span classnl>created_at/span>span classp>:/span>span classw> /span>span classs2>2016-02-19 10:30:02/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>A User Group resource details the core properties of a Mindful Feedback User Group. /p>p>The User Group API can be used to get details of user groups and manage which users belong to which User Group. /p>p>strong>JSON object contains the following information/strong>/p>table>thead>tr>th>Name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>id/code>/td>td>A unique user group ID./td>/tr>tr>td>code>name/code>/td>td>A unique name/td>/tr>tr>td>code>updated_at/code>/td>td>Timestamps specifying when the user group was last updated/td>/tr>tr>td>code>created_at/code>/td>td>Timestamps specifying when the user group was created/td>/tr>/tbody>/table>h2 idget-user-groups-list>Get User Groups List/h2>blockquote>p>This code will return the first 5 user groups/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/user_groups?_limit5/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/user_groups?_limit5/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/user_groups?_limit5/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/user_groups?_limit5/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>blockquote>p>This code will return the next 5 user groups/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/user_groups?_offset5&_limit5/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/user_groups?_limit5/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/user_groups?_offset5&_limit5/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/user_groups?_offset5&_limit5/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>p>Gets a list of user groups as a JSON array of User Group resources./p>h3 iduri>URI/h3>p>code>/user_groups/code>/p>h3 idmethod>Method/h3>p>code>GET/code>/p>h3 idparameters>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>_limit/code>/td>td>The number of User Groups to return./td>td>integer between 1 and 500/td>td>10/td>/tr>tr>td>code>_offset/code>/td>td>The row number to start at when getting _limit User Groups. Useful if you have more than 500 User Groups or wish to "paginate" your requests./td>td>integer/td>td>0/td>/tr>/tbody>/table>h2 idget-specific-user-group>Get Specific User Group/h2>blockquote>p>This code will return a JSON object for the User Group resource with ID  891234:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/user_groups/891234/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/user_groups/891234/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/user_groups/891234/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/user_groups/891234/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Returns the JSON object for a User Group resource specified by code>{user_group_id}/code>/p>h3 iduri-2>URI/h3>p>code>/user_groups/{user_group_id}/code>/p>h3 idmethod-2>Method/h3>p>code>GET/code>/p>h3 idparameters-2>Parameters/h3>p>None/p>h2 idget-users-from-user-group>Get Users from User Group/h2>blockquote>p>This code will return a JSON object of all Users in the the User Group resource with ID  891234:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/user_groups/891234/users/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/user_groups/891234/users/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/user_groups/891234/users/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/user_groups/891234/users/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>p>Returns the JSON object for Users in the User Group resource specified by code>{user_group_id}/code>/p>h3 iduri-3>URI/h3>p>code>/user_groups/{user_group_id}/users/code>/p>h3 idmethod-3>Method/h3>p>code>GET/code>/p>h3 idparameters-3>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>_limit/code>/td>td>The number of Users to return./td>td>integer between 1 and 500/td>td>10/td>/tr>tr>td>code>_offset/code>/td>td>The row number to start at when getting _limit Users. Useful if you have more than 500 Users in the specified User Group, or wish to "paginate" your requests./td>td>integer/td>td>0/td>/tr>/tbody>/table>h2 idcreate-new-user-group>Create New User Group/h2>blockquote>p>This code will create a User Group named 'My User Group':/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST   span classs2>https://surveydynamix.com/api/user_groups/create/span> span classse>\/span>    span classnt>-d/span> span classs2>nameMy User Group/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/user_groups/create/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>POST/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Type/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>application/x-www-form-urlencoded/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classkd>var/span> span classnx>data/span> span classo>/span> span classdl>/span>span classs2>nameMy User Group/span>span classdl>/span>span classp>;/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/user_groups/create/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POSTFIELDS/span>span classp>,/span> span classs2>nameMy User Group/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POST/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Content-Type: application/x-www-form-urlencoded/span>span classp>;/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>data/span> span classo>/span> span classs>nameMy User Group/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/user_groups/create/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>),/span> span classn>data/span>span classo>/span>span classn>data/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Creates a User Group with the specified parameters./p>h3 iduri-4>URI/h3>p>code>/user_groups/create/code>/p>h3 idmethod-4>Method/h3>p>code>POST/code>/p>h3 idparameters-4>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>name/code>/td>td>The name given to your User Group. Must be unique./td>td>string/td>td>No default; Parameter required/td>/tr>/tbody>/table>h2 idadd-users-to-user-group>Add Users to User Group/h2>blockquote>p>This code will add users with the ID 1234 and 2468 to the user group with the ID 6789./p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST   span classs2>https://surveydynamix.com/api/user_groups/6789/add_users/span> span classse>\/span>    span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span>    span classnt>-d/span> span classs1>{visibility_level:all,visible:1,user_ids:1234, 2468}/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/user_groups/6789/add_users/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>POST/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Type/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>application/json/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classkd>var/span> span classnx>data/span> span classo>/span> span classdl>/span>span classs1>{visibility_level:all,visible:1,user_ids:1234, 2468}/span>span classdl>/span>span classp>;/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/user_groups/6789/add_users/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POSTFIELDS/span>span classp>,/span> span classs2>{\/span>span classn>visibility_level/span>span classerr>\/span>span classs2>:/span>span classse>\/span>span classs2>all/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>visible/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>1/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>user_ids/span>span classse>\/span>span classs2>:1234, 2468}/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POST/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Content-Type: application/json/span>span classp>;/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>,/span>span classp>}/span>span classn>data/span> span classo>/span> span classs>{visibility_level:all,visible:1,user_ids:1234, 2468}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/user_groups/6789/add_users/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>data/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Adds the users that match code>user_ids/code> to the User Group specified by code>{user_group_id}/code>/p>h3 iduri-5>URI/h3>p>code>/user_groups/{user_group_id}/add_users/code>/p>h3 idmethod-5>Method/h3>p>code>POST/code>/p>h3 idparameters-5>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>user_ids/code>/td>td>An array of Mindful Feedback User IDs. You can obtain User IDs from the Users Resource by getting a a href#get-specific-user>specific user/a> or by getting a href#get-users-list>a list of all users/a>/td>td>Array/td>td>No default; Parameter required/td>/tr>tr>td>code>visibility_level/code>/td>td>The level of access the users have to other user's results within the same User Group./td>td>"all", "individual"/td>td>No default; Parameter required/td>/tr>tr>td>code>visible/code>/td>td>If true, the users being added are visible to other users in the same User Group/td>td>boolean/td>td>No default; Parameter required/td>/tr>/tbody>/table>h2 idremove-users-from-user-group>Remove Users from User Group/h2>blockquote>p>This code will remove users with the ID 1234 and 2468 from the user group with the ID 6789./p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST   span classs2>https://surveydynamix.com/api/user_groups/6789/remove_users/span> span classse>\/span>    span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span>    span classnt>-d/span> span classs1>{user_ids:1234,2468}/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>,/span>span classp>}/span>span classn>data/span> span classo>/span> span classs>{user_ids:1234,2468}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/user_groups/6789/remove_users/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>data/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/user_groups/6789/remove_users/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>POST/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Type/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>application/json/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classkd>var/span> span classnx>data/span> span classo>/span> span classdl>/span>span classs1>{user_ids:1234,2468}/span>span classdl>/span>span classp>;/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/user_groups/6789/remove_users/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POSTFIELDS/span>span classp>,/span> span classs2>/span>span classsi>{/span>span classnv>\user_ids\:1234,2468/span>span classsi>}/span>span classs2>/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POST/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Content-Type: application/json/span>span classp>;/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>p>Removes the users that match code>user_ids/code> from the User Group specified by code>{user_group_id}/code>/p>h3 iduri-6>URI/h3>p>code>/user_groups/{user_group_id}/remove_users/code>/p>h3 idmethod-6>Method/h3>p>code>POST/code>/p>h3 idparameters-6>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>user_ids/code>/td>td>An array of Mindful Feedback User IDs. You can obtain User IDs from the Users Resource by getting a a href#get-specific-user>specific user/a> or by getting a href#get-users-list>a list of all users/a>/td>td>Array/td>td>No default; Parameter required/td>/tr>/tbody>/table>h1 iddo-not-call-list>Do Not Call List/h1>blockquote>p>Do not call list entries follow this example format in JSON/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>/span>span classnl>contact/span>span classp>:/span>span classs2>+61409999999/span>span classp>,/span>span classw>/span>span classnl>added_at/span>span classp>:/span>span classw> /span>span classs2>2016-02-19 10:30:02/span>span classp>,/span>span classw>/span>span classnl>added_by_user_id/span>span classp>:/span>span classs2>65/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>The do not call list defines contacts which are not allowed to be surveyed via outbound telephony or email.The API can be used to retrieve lists of do not call entries, add contacts to the the do not call list, or remove them./p>p>strong>JSON object contains the following information/strong>/p>table>thead>tr>th>Name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>contact/code>/td>td>The contact which has been blocked. This is either a phone number or an email address./td>/tr>tr>td>code>added_at/code>/td>td>Timestamps specifying when the entry was created/td>/tr>tr>td>code>added_by_user_id/code>/td>td>The id of the user who added the entry. If the entry was added via the API or by the contact clicking an unsubscribe link, this field will be set to null./td>/tr>/tbody>/table>h2 idget-do-not-call-list>Get Do Not Call List/h2>blockquote>p>This code will return the full do not call list:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/do_not_call_list/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/do_not_call_list/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/do_not_call_list/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/do_not_call_list/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>blockquote>p>This code will return a JSON array of do not call list entries where the contact ends with "@gmail.com":/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/do_not_call_list?contact%25@gmail.com/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/do_not_call_list?contact%25@gmail.com/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/do_not_call_list?contact%25@gmail.com/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/do_not_call_list?contact%25@gmail.com/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Gets the do not call list, optionally filtered by contact./p>h3 iduri>URI/h3>p>code>/do_not_call_list/code>/p>h3 idmethod>Method/h3>p>code>GET/code>/p>h3 idparameters>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>contact/code>/td>td>A string to filter the list by. This accepts the wildcard character "%", allowing for example the ability to search contacts containing a specific email domain, or phone number area code./td>td>String/td>td>none/td>/tr>tr>td>code>_limit/code>/td>td>The number of matching Do Not Call resources to return./td>td>integer between 1 and 1000/td>td>10/td>/tr>tr>td>code>_offset/code>/td>td>The row number to start at if more than _limit Do Not Call resources are found./td>td>integer/td>td>0/td>/tr>tr>td>code>_order/code>/td>td>The order that results should be returned in./td>td>‘ASC’: earliest first/td>td>DESC/td>/tr>tr>td>/td>td>/td>td>or ‘DESC’: most recent first/td>td>/td>/tr>/tbody>/table>h2 idget-specific-do-not-call-list-entry>Get Specific Do Not Call List Entry/h2>blockquote>p>This code will return a JSON object for the do not call list entry "joebloggs@example.com":/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/do_not_call_list/joebloggs@example.com/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/do_not_call_list/joebloggs@example.com/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/do_not_call_list/joebloggs@example.com/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/do_not_call_list/joebloggs@example.com/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Returns the JSON object for a do not call list entry specified by the code>{contact}/code>./p>h3 iduri-2>URI/h3>p>code>/do_not_call_list/{contact}/code>/p>h3 idmethod-2>Method/h3>p>code>GET/code>/p>h3 idparameters-2>Parameters/h3>p>None/p>h2 idadd-do-not-call-list-entry>Add Do Not Call List Entry/h2>blockquote>p>This code will add the email address "joebloggs@example.com" to the do not call list:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST   span classs2>https://surveydynamix.com/api/do_not_call_list/span> span classse>\/span>    span classnt>-d/span> span classs2>contactjoebloggs@example.com/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/do_not_call_list/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>POST/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Type/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>application/x-www-form-urlencoded/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classkd>var/span> span classnx>data/span> span classo>/span> span classdl>/span>span classs2>contactjoebloggs@example.com/span>span classdl>/span>span classp>;/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/do_not_call_list/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POSTFIELDS/span>span classp>,/span> span classs2>contactjoebloggs@example.com/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POST/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Content-Type: application/x-www-form-urlencoded/span>span classp>;/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>data/span> span classo>/span> span classs>contactjoebloggs@example.com/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/do_not_call_list/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>),/span> span classn>data/span>span classo>/span>span classn>data/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>blockquote>p>This code will add the phone number "+61409999999" to the do not call list:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST   span classs2>https://surveydynamix.com/api/do_not_call_list/span> span classse>\/span>    span classnt>-d/span> span classs2>contact+61409999999/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/do_not_call_list/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>POST/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Type/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>application/x-www-form-urlencoded/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classkd>var/span> span classnx>data/span> span classo>/span> span classdl>/span>span classs2>contact+61409999999/span>span classdl>/span>span classp>;/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/do_not_call_list/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POSTFIELDS/span>span classp>,/span> span classs2>contact+61409999999/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POST/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Content-Type: application/x-www-form-urlencoded/span>span classp>;/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>data/span> span classo>/span> span classs>contact+61409999999/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/do_not_call_list/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>),/span> span classn>data/span>span classo>/span>span classn>data/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Adds a contact to the do not call list./p>p>The resulting do not call list entry JSON object will be returned./p>h3 iduri-3>URI/h3>p>code>/do_not_call_list/code>/p>h3 idmethod-3>Method/h3>p>code>POST/code>/p>h3 idparameters-3>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>contact/code>/td>td>The phone number or email address of the contact to add to the do not call list/td>td>String/td>td>No default; Parameter required/td>/tr>/tbody>/table>h2 iddelete-do-not-call-list-entry>Delete Do Not Call List Entry/h2>blockquote>p>This code will remove the email address "joebloggs@example.com" from the do not call list:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> DELETE   span classs2>https://surveydynamix.com/api/do_not_call_list/joebloggs@example.com/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/do_not_call_list/joebloggs@example.com/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>DELETE/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/do_not_call_list/joebloggs@example.com/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>DELETE/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>delete/span>span classp>(/span>span classs>https://surveydynamix.com/api/do_not_call_list/joebloggs@example.com/span>span classp>,/span>span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Removes do not call list entry specified by code>{contact}/code>./p>h3 iduri-4>URI/h3>p>code>/do_not_call_list/{contact}/code>/p>h3 idmethod-4>Method/h3>p>code>DELETE/code>/p>h3 idparameters-4>Parameters/h3>p>None/p>h1 idsurvey-prompts>Survey Prompts/h1>blockquote>p>Survey prompts follow this example format in JSON/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>  /span>span classnl>text/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2>Wed love to get some feedback on your recent customer experience!/span>span classp>,/span>span classw>      /span>span classnl>en-au/span>span classp>:/span>span classw> /span>span classs2>Gday! Wed love some feedback on your recent customer experience!/span>span classp>,/span>span classw>      /span>span classnl>es-default/span>span classp>:/span>span classw> /span>span classs2>Nos encantaría recibir algunos comentarios sobre su experiencia reciente con el cliente/span>span classw>  /span>span classp>},/span>span classw>  /span>span classnl>sound_files/span>span classp>:/span>span classw> /span>span classp>{/span>span classw>      /span>span classnl>default/span>span classp>:/span>span classw> /span>span classs2><sound file url>.mp3/span>span classp>,/span>span classw>      /span>span classnl>en-default/span>span classp>:/span>span classw> /span>span classs2><sound file url>.mp3/span>span classp>,/span>span classw>      /span>span classnl>en-au/span>span classp>:/span>span classw> /span>span classs2><sound file url>.mp3/span>span classp>,/span>span classw>      /span>span classnl>es-default/span>span classp>:/span>span classw> /span>span classs2><sound file url>.mp3/span>span classw>  /span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Survey prompts define what should be shown or played to a respondent while performing a survey./p>p>Each survey prompt JSON object contains at least the text list, while the sound files list is only present if at least the default sound file is defined./p>p>At runtime Mindful Feedback dynamically chooses which prompt to present based on the respondent language defined in the survey interaction, using defaults if the specific language is not defined. For example, if the respondent language is set to en-AU, it will first look for the text key "en-au". If that key is not defined, it will then look for "en-default", before finally presenting the "default" text if no other is defined. For a full list of supported language codes, check a href#supported-languages>here/a>/p>h2 idsurvey-text-prompts>Survey Text Prompts/h2>p>Survey text prompts are used for survey prompts which are not used in voice surveys. These prompts will never contain a sound file list./p>h1 idphone-numbers>Phone Numbers/h1>blockquote>p>Phone number lookup results follow this example format in JSON/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>    /span>span classnl>phone_number/span>span classp>:/span>span classw> /span>span classs2>+61499999999/span>span classp>,/span>span classw>    /span>span classnl>country_code/span>span classp>:/span>span classw> /span>span classs2>AU/span>span classp>,/span>span classw>    /span>span classnl>national_format/span>span classp>:/span>span classw> /span>span classs2>0499 999 999/span>span classp>,/span>span classw>    /span>span classnl>phone_type/span>span classp>:/span>span classw> /span>span classs2>mobile/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>Phone numbers in SDX are required to be in a specific international format. This resource allows you to lookup a phone number and get basic details including it's correct format for SDX, where it is located, and whether it is able to receive SMS surveys./p>p>strong>JSON object contains the following information/strong>/p>table>thead>tr>th>Name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>phone_number/code>/td>td>The phone number in the correct format expected by Mindful Feedback/td>/tr>tr>td>code>country_code/code>/td>td>The country code of where the phone number is registered/td>/tr>tr>td>code>national_format/code>/td>td>The national format for the phone number/td>/tr>tr>td>code>phone_type/code>/td>td>The phone type. This is either mobile, landline, or voip./td>/tr>/tbody>/table>aside classnotice> Mobile numbers are usually able to receive SMS surveys, while voip numbers are uncertain, and landline numbers are usually invalid. If an SMS survey interaction is created for an invalid SMS number, the interaction will not be performed at the scheduled time and will instead be marked as abandoned. /aside>h2 idget-phone-number-details>Get Phone Number Details/h2>blockquote>p>This code will return the details of the Australian mobile number 0499999999 in the correct format required by Mindful Feedback/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> GET   span classs2>https://surveydynamix.com/api/phone_numbers/0499999999?country_codeAU/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/phone_numbers/0499999999?country_codeAU/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>GET/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>();/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/phone_numbers/0499999999?country_codeAU/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_CUSTOMREQUEST/span>span classp>,/span> span classs1>GET/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>get/span>span classp>(/span>span classs>https://surveydynamix.com/api/phone_numbers/0499999999?country_codeAU/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Gets the specific details of a phone number. If the phone number is not valid, a 404 response will be returned instead./p>h3 iduri>URI/h3>p>code>/phone_numbers/{phone_number}/code>/p>h3 idmethod>Method/h3>p>code>GET/code>/p>h3 idparameters>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>country_code/code>/td>td>The ISO country code of the phone number.  This is used to specify the country when the number is provided in a national format./td>td>String/td>td>US/td>/tr>/tbody>/table>h1 idpstn-transfer-reservations>PSTN Transfer Reservations/h1>blockquote>p>PSTN Transfer Reservation resources follow this example format in JSON/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>/span>span classnl>survey_id/span>span classp>:/span>span classmi>50/span>span classp>,/span>span classw>/span>span classnl>external_ref/span>span classp>:/span>span classw> /span>span classs2>7aa870f0-046f-11e7-9cc9-9de741d6e753/span>span classp>,/span>span classw>/span>span classnl>custom_data/span>span classp>:/span>span classw> /span>span classp>{/span>span classnl>call_type/span>span classp>:/span>span classs2>Service/span>span classp>,/span>span classnl>respondent_language/span>span classp>:/span>span classs2>en-US/span>span classp>,/span>span classnl>agent_id/span>span classp>:/span>span classs2>aboyd/span>span classp>,/span>span classnl>wrapup/span>span classp>:/span>span classs2>Problem solved/span>span classp>,/span>span classnl>HandleTime/span>span classp>:/span>span classs2>144/span>span classp>},/span>span classw>/span>span classnl>inbound_number/span>span classp>:/span>span classw> /span>span classs2>+61490000000/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>A PSTN Transfer Reservation is a way for you to give Mindful Feedback a unique ID and set of attributes for a future incoming call, when SIP transfers are not available. In response, Mindful Feedback will send back an code>inbound_number/code>, which you can transfer a caller to and the call will be assigned the attributes of the API request you just performed. /p>p>As a basic example, your survey might support multiple languages. However, a PSTN transfer has no way to notify Feedback of the incoming caller's language. That's where the PSTN Transfer Reservation comes in, telling Feedback that a call is about to arrive where the code>respondent_language/code> attribute is code>en-US/code>. Feedback sends back the phone number to which the caller should be transferred, and when the caller arrives at Feedback, we're expecting them and can conduct the survey in the appropriate language. /p>p>strong>JSON object contains the following information/strong>/p>table>thead>tr>th>Name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>survey_id/code>/td>td>The ID of the survey you want the caller to hear when they are transferred./td>/tr>tr>td>code>external_ref/code>/td>td>A unique ID that will be assigned to the interaction when the caller is transferred./td>/tr>tr>td>code>custom_data/code>/td>td>A set of key/value pairs, which can contain any information you want on the interaction. Common information might be respondent_languageen-AU or call_typeGeneralEnquiries, but you can add any data you need to the interaction./td>/tr>tr>td>code>inbound_number/code>/td>td>The phone number to which the caller must be transferred./td>/tr>/tbody>/table>h2 idadd-new-pstn-transfer-reservation>Add New PSTN Transfer Reservation/h2>blockquote>p>This code will create a PSTN Transfer Reservation. The response will contain an code>inbound_number/code> attribute. If a user is transferred to this number within 10 seconds of the API call, the call with be assigned the code>external_ref/code> and code>custom_data/code> and the caller will hear the survey with the ID of code>survey_id/code>. /p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST   span classs2>https://surveydynamix.com/api/create_transfer_reservation/span> span classse>\/span>    span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span>    span classnt>-d/span> span classs1>{external_ref:7aa870f0-046f-11e7-9cc9-9de741d6e753,survey_id:50,custom_data: {call_type:Service,respondent_language:en-US,agent_id:aboyd, wrapup:Problem solved, HandleTime:144}}/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/create_transfer_reservation/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>POST/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Type/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>application/json/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classkd>var/span> span classnx>data/span> span classo>/span> span classdl>/span>span classs1>{external_ref:7aa870f0-046f-11e7-9cc9-9de741d6e753,survey_id:50,custom_data: {call_type:Service,respondent_language:en-US,agent_id:aboyd, wrapup:Problem solved, HandleTime:144}}/span>span classdl>/span>span classp>;/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/create_transfer_reservation/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POSTFIELDS/span>span classp>,/span> span classs2>{\/span>span classn>external_ref/span>span classerr>\/span>span classs2>:/span>span classse>\/span>span classs2>7aa870f0-046f-11e7-9cc9-9de741d6e753/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>survey_id/span>span classse>\/span>span classs2>:50,/span>span classse>\/span>span classs2>custom_data/span>span classse>\/span>span classs2>: {\/span>span classn>call_type/span>span classerr>\/span>span classs2>:/span>span classse>\/span>span classs2>Service/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>respondent_language/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>en-US/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>agent_id/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>aboyd/span>span classse>\/span>span classs2>, /span>span classse>\/span>span classs2>wrapup/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>Problem solved/span>span classse>\/span>span classs2>, /span>span classse>\/span>span classs2>HandleTime/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>144/span>span classse>\/span>span classs2>}}/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POST/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Content-Type: application/json/span>span classp>;/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>,/span>span classp>}/span>span classn>data/span> span classo>/span> span classs>{external_ref:7aa870f0-046f-11e7-9cc9-9de741d6e753,survey_id:50,custom_data: {call_type:Service,respondent_language:en-US,agent_id:aboyd, wrapup:Problem solved, HandleTime:144}}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/create_transfer_reservation/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>data/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>))/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>p>Creates a PSTN Transfer Reservation/p>h3 iduri>URI/h3>p>code>/create_transfer_reservation/code>/p>h3 idmethod>Method/h3>p>code>POST/code>/p>h3 idparameters>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>external_ref/code>/td>td>A unique ID that will be assigned to the incoming call./td>td>string/td>td>No default; Parameter required/td>/tr>tr>td>code>custom_data/code>/td>td>A set of key/value pairs that are assigned to the incoming call./td>td>JSON. The keys must only include alphanumeric characters and underscores and must start with a letter. The values may be any string./td>td>none/td>/tr>tr>td>code>survey_id/code>/td>td>The ID of the survey you want the caller to complete./td>td>Integer/td>td>No default; Parameter required/td>/tr>tr>td>code>phone_number_prefix/code>/td>td>Requests an inbound phone number starting with the prefix. If none is available, the code>phone_number_prefix/code> will be ignored and the next available number will be returned./td>td>string/td>td>none/td>/tr>/tbody>/table>h1 idsip-transfer-reservations>SIP Transfer Reservations/h1>blockquote>p>SIP Transfer Reservation resources follow this example format in JSON/p>/blockquote>div classhighlight>pre classhighlight json tab-json>code>span classp>{/span>span classw>/span>span classnl>external_ref/span>span classp>:/span>span classw> /span>span classs2>7aa870f0-046f-11e7-9cc9-9de741d6e753/span>span classp>,/span>span classw>/span>span classnl>custom_data/span>span classp>:/span>span classw> /span>span classp>{/span>span classnl>call_type/span>span classp>:/span>span classs2>General Enquiries/span>span classp>,/span>span classnl>respondent_language/span>span classp>:/span>span classs2>en-AU/span>span classp>,/span>span classnl>some_other_custom_field/span>span classp>:/span>span classs2>value/span>span classp>,/span>span classnl>etc/span>span classp>:/span>span classs2>etc/span>span classp>}/span>span classw>/span>span classp>}/span>span classw>/span>/code>/pre>/div>p>A SIP Transfer Reservation is a way for you to give Mindful Feedback information about an incoming SIP call./p>p>This functionality allows you to make an API call to Mindful Feedback before transferring a SIP call, so that Feedback is expecting the call and can associate it with data from the API call./p>p>strong>JSON object contains the following information/strong>/p>table>thead>tr>th>Name/th>th>Description/th>/tr>/thead>tbody>tr>td>code>external_ref/code>/td>td>This must match the code>SIPHEADER_X-SDX-external_ref/code> header on your incoming SIP call/td>/tr>tr>td>code>custom_data/code>/td>td>A set of key/value pairs, which can contain any information you want on the interaction. Common information might be respondent_languageen-AU or call_typeGeneralEnquiries, but you can add any data you need to the interaction./td>/tr>/tbody>/table>h2 idadd-new-sip-transfer-reservation>Add New SIP Transfer Reservation/h2>blockquote>p>This code will create a SIP Transfer Reservation. If an incoming SIP call arrives with the same external_ref, it will be assigned a call_type, agent_id and respondent_language:/p>/blockquote>div classhighlight>pre classhighlight shell tab-shell>code>curl span classnt>-X/span> POST   span classs2>https://surveydynamix.com/api/create_incoming_sip_data/span> span classse>\/span>    span classnt>-H/span> span classs1>Content-Type: application/json/span> span classse>\/span>    span classnt>-d/span> span classs1>{external_ref:7aa870f0-046f-11e7-9cc9-9de741d6e753,custom_data: {call_type:customer satisfaction,respondent_language:en-AU,agent_id:al_boyd}}/span> span classse>\/span>    span classnt>-u/span> Customer_UUID:Auth_Token/code>/pre>/div>div classhighlight>pre classhighlight python tab-python>code>span classkn>import/span> span classnn>requests/span>span classn>headers/span> span classo>/span> span classp>{/span>    span classs>Content-Type/span>span classp>:/span> span classs>application/json/span>span classp>,/span>span classp>}/span>span classn>data/span> span classo>/span> span classs>{external_ref:7aa870f0-046f-11e7-9cc9-9de741d6e753,custom_data: {call_type:customer satisfaction,respondent_language:en-AU,agent_id:al_boyd}}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classp>./span>span classn>post/span>span classp>(/span>span classs>https://surveydynamix.com/api/create_incoming_sip_data/span>span classp>,/span> span classn>auth/span>span classo>/span>span classn>HTTPBasicAuth/span>span classp>(/span>span classn>Customer_UUID/span>span classp>,/span> span classn>Auth_Token/span>span classp>),/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>data/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classp>./span>span classn>content/span>span classp>)/span>/code>/pre>/div>div classhighlight>pre classhighlight php tab-php>code>span classnv>$ch/span> span classo>/span> span classnb>curl_init/span>span classp>();/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_URL/span>span classp>,/span> span classs1>https://surveydynamix.com/api/create_incoming_sip_data/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_RETURNTRANSFER/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POSTFIELDS/span>span classp>,/span> span classs2>{\/span>span classn>external_ref/span>span classerr>\/span>span classs2>:/span>span classse>\/span>span classs2>7aa870f0-046f-11e7-9cc9-9de741d6e753/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>custom_data/span>span classse>\/span>span classs2>: {\/span>span classn>call_type/span>span classerr>\/span>span classs2>:/span>span classse>\/span>span classs2>customer satisfaction/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>respondent_language/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>en-AU/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>agent_id/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>al_boyd/span>span classse>\/span>span classs2>}}/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_POST/span>span classp>,/span> span classmi>1/span>span classp>);/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_USERPWD/span>span classp>,/span> span classs1>Customer_UUID/span> span classmf>./span> span classs1>:/span> span classmf>./span> span classs1>Auth_Token/span>span classp>);/span>span classnv>$headers/span> span classo>/span> span classk>array/span>span classp>();/span>span classnv>$headers/span>span classp>/span> span classo>/span> span classs1>Content-Type: application/json/span>span classp>;/span>span classnb>curl_setopt/span>span classp>(/span>span classnv>$ch/span>span classp>,/span> span classno>CURLOPT_HTTPHEADER/span>span classp>,/span> span classnv>$headers/span>span classp>);/span>span classnv>$result/span> span classo>/span> span classnb>curl_exec/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classk>if/span> span classp>(/span>span classnb>curl_errno/span>span classp>(/span>span classnv>$ch/span>span classp>))/span> span classp>{/span>    span classk>echo/span> span classs1>Error:/span> span classmf>./span> span classnb>curl_error/span>span classp>(/span>span classnv>$ch/span>span classp>);/span>span classp>}/span>span classnb>curl_close/span> span classp>(/span>span classnv>$ch/span>span classp>);/span>/code>/pre>/div>div classhighlight>pre classhighlight javascript tab-javascript>code>span classkd>var/span> span classnx>url/span> span classo>/span> span classdl>/span>span classs2>https://surveydynamix.com/api/create_incoming_sip_data/span>span classdl>/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classdl>/span>span classs2>POST/span>span classdl>/span>span classp>,/span> span classnx>url/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Content-Type/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>application/json/span>span classdl>/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classdl>/span>span classs2>Authorization/span>span classdl>/span>span classp>,/span> span classdl>/span>span classs2>Basic /span>span classdl>/span> span classo>+/span> span classnx>btoa/span>span classp>(/span>span classnx>username/span> span classo>+/span> span classdl>/span>span classs2>:/span>span classdl>/span> span classo>+/span> span classnx>password/span>span classp>));/span>span classnx>xhr/span>span classp>./span>span classnx>onreadystatechange/span> span classo>/span> span classkd>function/span> span classp>()/span> span classp>{/span>   span classk>if/span> span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classmi>4/span>span classp>)/span> span classp>{/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>status/span>span classp>);/span>      span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>xhr/span>span classp>./span>span classnx>responseText/span>span classp>);/span>   span classp>}};/span>span classkd>var/span> span classnx>data/span> span classo>/span> span classdl>/span>span classs1>{external_ref:7aa870f0-046f-11e7-9cc9-9de741d6e753,custom_data: {call_type:customer satisfaction,respondent_language:en-AU,agent_id:al_boyd}}/span>span classdl>/span>span classp>;/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre>/div>p>Creates a SIP Transfer Reservation/p>h3 iduri>URI/h3>p>code>/create_incoming_sip_data/code>/p>h3 idmethod>Method/h3>p>code>POST/code>/p>h3 idparameters>Parameters/h3>table>thead>tr>th>Name/th>th>Description/th>th>Allowed Values/th>th>Default/th>/tr>/thead>tbody>tr>td>code>external_ref/code>/td>td>A standard string field for linking SIP Transfer Reservation to an incoming SIP call./td>td>string/td>td>No default; Parameter required/td>/tr>tr>td>code>custom_data/code>/td>td>Any data that should be associated with the incoming SIP call./td>td>JSON. The keys must only include alphanumeric characters and underscores and must start with a letter. The values may be any string./td>td>none/td>/tr>/tbody>/table>h1 idsupported-languages>Supported Languages/h1>p>Mindful Feedback Supports the following respondent languages for survey prompt and response transcription purposes:/p>table>thead>tr>th>Language/th>th>languageCode/th>th>Language (English name)/th>/tr>/thead>tbody>tr>td>Afrikaans (Suid-Afrika)/td>td>code>af-ZA/code>/td>td>Afrikaans (South Africa)/td>/tr>tr>td>gjuha shqipe (Shqiperia)/td>td>code>sq-AL/code>/td>td>Albanian (Albania)/td>/tr>tr>td>አማርኛ (ኢትዮጵያ)/td>td>code>am-ET/code>/td>td>Amharic (Ethiopia)/td>/tr>tr>td>العربية (الجزائر)/td>td>code>ar-DZ/code>/td>td>Arabic (Algeria)/td>/tr>tr>td>العربية (البحرين)/td>td>code>ar-BH/code>/td>td>Arabic (Bahrain)/td>/tr>tr>td>العربية (مصر)/td>td>code>ar-EG/code>/td>td>Arabic (Egypt)/td>/tr>tr>td>العربية (العراق)/td>td>code>ar-IQ/code>/td>td>Arabic (Iraq)/td>/tr>tr>td>العربية (إسرائيل)/td>td>code>ar-IL/code>/td>td>Arabic (Israel)/td>/tr>tr>td>العربية (الأردن)/td>td>code>ar-JO/code>/td>td>Arabic (Jordan)/td>/tr>tr>td>العربية (الكويت)/td>td>code>ar-KW/code>/td>td>Arabic (Kuwait)/td>/tr>tr>td>العربية (لبنان)/td>td>code>ar-LB/code>/td>td>Arabic (Lebanon)/td>/tr>tr>td>العربية (المغرب)/td>td>code>ar-MA/code>/td>td>Arabic (Morocco)/td>/tr>tr>td>العربية (عُمان)/td>td>code>ar-OM/code>/td>td>Arabic (Oman)/td>/tr>tr>td>العربية (قطر)/td>td>code>ar-QA/code>/td>td>Arabic (Qatar)/td>/tr>tr>td>العربية (السعودية)/td>td>code>ar-SA/code>/td>td>Arabic (Saudi Arabia)/td>/tr>tr>td>العربية (فلسطين)/td>td>code>ar-PS/code>/td>td>Arabic (State of Palestine)/td>/tr>tr>td>العربية (تونس)/td>td>code>ar-TN/code>/td>td>Arabic (Tunisia)/td>/tr>tr>td>العربية (الإمارات)/td>td>code>ar-AE/code>/td>td>Arabic (United Arab Emirates)/td>/tr>tr>td>العربية (اليمن)/td>td>code>ar-YE/code>/td>td>Arabic (Yemen)/td>/tr>tr>td>Հայ (Հայաստան)/td>td>code>hy-AM/code>/td>td>Armenian (Armenia)/td>/tr>tr>td>Azərbaycan (Azərbaycan)/td>td>code>az-AZ/code>/td>td>Azerbaijani (Azerbaijan)/td>/tr>tr>td>Bahasa Indonesia (Indonesia)/td>td>code>id-ID/code>/td>td>Indonesian (Indonesia)/td>/tr>tr>td>Bahasa Melayu (Malaysia)/td>td>code>ms-MY/code>/td>td>Malay (Malaysia)/td>/tr>tr>td>বাংলা (বাংলাদেশ)/td>td>code>bn-BD/code>/td>td>Bengali (Bangladesh)/td>/tr>tr>td>বাংলা (ভারত)/td>td>code>bn-IN/code>/td>td>Bengali (India)/td>/tr>tr>td>босански (Босна и Херцеговина)/td>td>code>bs-BA/code>/td>td>Bosnian (Bosnia and Herzegovina)/td>/tr>tr>td>Български (България)/td>td>code>bg-BG/code>/td>td>Bulgarian (Bulgaria)/td>/tr>tr>td>မြန်မာစကား/td>td>code>my-MM/code>/td>td>Burmese (Myanmar)/td>/tr>tr>td>Català (Espanya)/td>td>code>ca-ES/code>/td>td>Catalan (Spain)/td>/tr>tr>td>Čeština (Česká republika)/td>td>code>cs-CZ/code>/td>td>Czech (Czech Republic)/td>/tr>tr>td>國語 (台灣)/td>td>code>cmn-Hant-TW/code>/td>td>Chinese, Mandarin (Traditional, Taiwan)/td>/tr>tr>td>廣東話 (香港)/td>td>code>yue-Hant-HK/code>/td>td>Chinese, Cantonese (Traditional, Hong Kong)/td>/tr>tr>td>普通话 (中国大陆)/td>td>code>cmn-Hans-CN/code>/td>td>Chinese, Mandarin (Simplified, China)/td>/tr>tr>td>普通話 (香港)/td>td>code>cmn-Hans-HK/code>/td>td>Chinese, Mandarin (Simplified, Hong Kong)/td>/tr>tr>td>Dansk (Danmark)/td>td>code>da-DK/code>/td>td>Danish (Denmark)/td>/tr>tr>td>Deutsch (Österreich)/td>td>code>de-AT/code>/td>td>German (Austria)/td>/tr>tr>td>Deutsch (Deutschland)/td>td>code>de-DE/code>/td>td>German (Germany)/td>/tr>tr>td>Deutsch (Schweiz)/td>td>code>de-CH/code>/td>td>German (Switzerland)/td>/tr>tr>td>English (Australia)/td>td>code>en-AU/code>/td>td>English (Australia)/td>/tr>tr>td>English (Canada)/td>td>code>en-CA/code>/td>td>English (Canada)/td>/tr>tr>td>English (Ghana)/td>td>code>en-GH/code>/td>td>English (Ghana)/td>/tr>tr>td>English (Hong Kong)/td>td>code>en-HK/code>/td>td>English (Hong Kong)/td>/tr>tr>td>English (Great Britain)/td>td>code>en-GB/code>/td>td>English (United Kingdom)/td>/tr>tr>td>English (India)/td>td>code>en-IN/code>/td>td>English (India)/td>/tr>tr>td>English (Ireland)/td>td>code>en-IE/code>/td>td>English (Ireland)/td>/tr>tr>td>English (Kenya)/td>td>code>en-KE/code>/td>td>English (Kenya)/td>/tr>tr>td>English (New Zealand)/td>td>code>en-NZ/code>/td>td>English (New Zealand)/td>/tr>tr>td>English (Nigeria)/td>td>code>en-NG/code>/td>td>English (Nigeria)/td>/tr>tr>td>English (Pakistan)/td>td>code>en-PK/code>/td>td>English (Pakistan)/td>/tr>tr>td>English (Philippines)/td>td>code>en-PH/code>/td>td>English (Philippines)/td>/tr>tr>td>English (Singapore)/td>td>code>en-SG/code>/td>td>English (Singapore)/td>/tr>tr>td>English (South Africa)/td>td>code>en-ZA/code>/td>td>English (South Africa)/td>/tr>tr>td>English (Tanzania)/td>td>code>en-TZ/code>/td>td>English (Tanzania)/td>/tr>tr>td>English (United States)/td>td>code>en-US/code>/td>td>English (United States)/td>/tr>tr>td>Español (Argentina)/td>td>code>es-AR/code>/td>td>Spanish (Argentina)/td>/tr>tr>td>Español (Bolivia)/td>td>code>es-BO/code>/td>td>Spanish (Bolivia)/td>/tr>tr>td>Español (Chile)/td>td>code>es-CL/code>/td>td>Spanish (Chile)/td>/tr>tr>td>Español (Colombia)/td>td>code>es-CO/code>/td>td>Spanish (Colombia)/td>/tr>tr>td>Español (Costa Rica)/td>td>code>es-CR/code>/td>td>Spanish (Costa Rica)/td>/tr>tr>td>Español (Ecuador)/td>td>code>es-EC/code>/td>td>Spanish (Ecuador)/td>/tr>tr>td>Español (El Salvador)/td>td>code>es-SV/code>/td>td>Spanish (El Salvador)/td>/tr>tr>td>Español (España)/td>td>code>es-ES/code>/td>td>Spanish (Spain)/td>/tr>tr>td>Español (Estados Unidos)/td>td>code>es-US/code>/td>td>Spanish (United States)/td>/tr>tr>td>Español (Guatemala)/td>td>code>es-GT/code>/td>td>Spanish (Guatemala)/td>/tr>tr>td>Español (Honduras)/td>td>code>es-HN/code>/td>td>Spanish (Honduras)/td>/tr>tr>td>Español (México)/td>td>code>es-MX/code>/td>td>Spanish (Mexico)/td>/tr>tr>td>Español (Nicaragua)/td>td>code>es-NI/code>/td>td>Spanish (Nicaragua)/td>/tr>tr>td>Español (Panamá)/td>td>code>es-PA/code>/td>td>Spanish (Panama)/td>/tr>tr>td>Español (Paraguay)/td>td>code>es-PY/code>/td>td>Spanish (Paraguay)/td>/tr>tr>td>Español (Perú)/td>td>code>es-PE/code>/td>td>Spanish (Peru)/td>/tr>tr>td>Español (Puerto Rico)/td>td>code>es-PR/code>/td>td>Spanish (Puerto Rico)/td>/tr>tr>td>Español (República Dominicana)/td>td>code>es-DO/code>/td>td>Spanish (Dominican Republic)/td>/tr>tr>td>Español (Uruguay)/td>td>code>es-UY/code>/td>td>Spanish (Uruguay)/td>/tr>tr>td>Español (Venezuela)/td>td>code>es-VE/code>/td>td>Spanish (Venezuela)/td>/tr>tr>td>eesti keel (Eesti)/td>td>code>et-EE/code>/td>td>Estonian (Estonia)/td>/tr>tr>td>Euskara (Espainia)/td>td>code>eu-ES/code>/td>td>Basque (Spain)/td>/tr>tr>td>Filipino (Pilipinas)/td>td>code>fil-PH/code>/td>td>Filipino (Philippines)/td>/tr>tr>td>Français (Belgium)/td>td>code>fr-BE/code>/td>td>French (Belgium)/td>/tr>tr>td>Français (Canada)/td>td>code>fr-CA/code>/td>td>French (Canada)/td>/tr>tr>td>Français (France)/td>td>code>fr-FR/code>/td>td>French (France)/td>/tr>tr>td>Français (Switzerland)/td>td>code>fr-CH/code>/td>td>French (Switzerland)/td>/tr>tr>td>Galego (España)/td>td>code>gl-ES/code>/td>td>Galician (Spain)/td>/tr>tr>td>ქართული (საქართველო)/td>td>code>ka-GE/code>/td>td>Georgian (Georgia)/td>/tr>tr>td>Ελληνικά (Ελλάδα)/td>td>code>el-GR/code>/td>td>Greek (Greece)/td>/tr>tr>td>ગુજરાતી (ભારત)/td>td>code>gu-IN/code>/td>td>Gujarati (India)/td>/tr>tr>td>עברית (ישראל)/td>td>code>iw-IL/code>/td>td>Hebrew (Israel)/td>/tr>tr>td>हिन्दी (भारत)/td>td>code>hi-IN/code>/td>td>Hindi (India)/td>/tr>tr>td>Hrvatski (Hrvatska)/td>td>code>hr-HR/code>/td>td>Croatian (Croatia)/td>/tr>tr>td>IsiZulu (Ningizimu Afrika)/td>td>code>zu-ZA/code>/td>td>Zulu (South Africa)/td>/tr>tr>td>Íslenska (Ísland)/td>td>code>is-IS/code>/td>td>Icelandic (Iceland)/td>/tr>tr>td>Italiano (Italia)/td>td>code>it-IT/code>/td>td>Italian (Italy)/td>/tr>tr>td>Italiano (Switzerland)/td>td>code>it-CH/code>/td>td>Italian (Switzerland)/td>/tr>tr>td>日本語（日本）/td>td>code>ja-JP/code>/td>td>Japanese (Japan)/td>/tr>tr>td>Jawa (Indonesia)/td>td>code>jv-ID/code>/td>td>Javanese (Indonesia)/td>/tr>tr>td>ಕನ್ನಡ (ಭಾರತ)/td>td>code>kn-IN/code>/td>td>Kannada (India)/td>/tr>tr>td>ភាសាខ្មែរ (កម្ពុជា)/td>td>code>km-KH/code>/td>td>Khmer (Cambodia)/td>/tr>tr>td>한국어 (대한민국)/td>td>code>ko-KR/code>/td>td>Korean (South Korea)/td>/tr>tr>td>ລາວ (ລາວ)/td>td>code>lo-LA/code>/td>td>Lao (Laos)/td>/tr>tr>td>Latviešu (latviešu)/td>td>code>lv-LV/code>/td>td>Latvian (Latvia)/td>/tr>tr>td>Lietuvių (Lietuva)/td>td>code>lt-LT/code>/td>td>Lithuanian (Lithuania)/td>/tr>tr>td>македонски (Македонија)/td>td>code>mk-MK/code>/td>td>Macedonian (North Macedonia)/td>/tr>tr>td>Magyar (Magyarország)/td>td>code>hu-HU/code>/td>td>Hungarian (Hungary)/td>/tr>tr>td>മലയാളം (ഇന്ത്യ)/td>td>code>ml-IN/code>/td>td>Malayalam (India)/td>/tr>tr>td>मराठी (भारत)/td>td>code>mr-IN/code>/td>td>Marathi (India)/td>/tr>tr>td>монгол (Монгол Улс)/td>td>code>mn-MN/code>/td>td>Mongolian (Mongolia)/td>/tr>tr>td>Nederlands (Nederland)/td>td>code>nl-BE/code>/td>td>Dutch (Belgium)/td>/tr>tr>td>Nederlands (Nederland)/td>td>code>nl-NL/code>/td>td>Dutch (Netherlands)/td>/tr>tr>td>नेपाली (नेपाल)/td>td>code>ne-NP/code>/td>td>Nepali (Nepal)/td>/tr>tr>td>Norsk bokmål (Norge)/td>td>code>no-NO/code>/td>td>Norwegian Bokmål (Norway)/td>/tr>tr>td>فارسی (ایران)/td>td>code>fa-IR/code>/td>td>Persian (Iran)/td>/tr>tr>td>Polski (Polska)/td>td>code>pl-PL/code>/td>td>Polish (Poland)/td>/tr>tr>td>Português (Brasil)/td>td>code>pt-BR/code>/td>td>Portuguese (Brazil)/td>/tr>tr>td>Português (Portugal)/td>td>code>pt-PT/code>/td>td>Portuguese (Portugal)/td>/tr>tr>td>ਪੰਜਾਬੀ (ਗੁਰਮੁਖੀ ਇੰਡੀਆ)/td>td>code>pa-Guru-IN/code>/td>td>Punjabi (Gurmukhi India)/td>/tr>tr>td>Română (România)/td>td>code>ro-RO/code>/td>td>Romanian (Romania)/td>/tr>tr>td>Русский (Россия)/td>td>code>ru-RU/code>/td>td>Russian (Russia)/td>/tr>tr>td>Српски (Србија)/td>td>code>sr-RS/code>/td>td>Serbian (Serbia)/td>/tr>tr>td>සිංහල (ශ්රී ලංකාව)/td>td>code>si-LK/code>/td>td>Sinhala (Sri Lanka)/td>/tr>tr>td>Slovenčina (Slovensko)/td>td>code>sk-SK/code>/td>td>Slovak (Slovakia)/td>/tr>tr>td>Slovenščina (Slovenija)/td>td>code>sl-SI/code>/td>td>Slovenian (Slovenia)/td>/tr>tr>td>Suomi (Suomi)/td>td>code>fi-FI/code>/td>td>Finnish (Finland)/td>/tr>tr>td>Svenska (Sverige)/td>td>code>sv-SE/code>/td>td>Swedish (Sweden)/td>/tr>tr>td>Swahili (Tanzania)/td>td>code>sw-TZ/code>/td>td>Swahili (Tanzania)/td>/tr>tr>td>Swahili (Kenya)/td>td>code>sw-KE/code>/td>td>Swahili (Kenya)/td>/tr>tr>td>தமிழ் (இந்தியா)/td>td>code>ta-IN/code>/td>td>Tamil (India)/td>/tr>tr>td>தமிழ் (மலேசியா)/td>td>code>ta-MY/code>/td>td>Tamil (Malaysia)/td>/tr>tr>td>தமிழ் (சிங்கப்பூர்)/td>td>code>ta-SG/code>/td>td>Tamil (Singapore)/td>/tr>tr>td>தமிழ் (இலங்கை)/td>td>code>ta-LK/code>/td>td>Tamil (Sri Lanka)/td>/tr>tr>td>తెలుగు (భారతదేశం)/td>td>code>te-IN/code>/td>td>Telugu (India)/td>/tr>tr>td>ไทย (ประเทศไทย)/td>td>code>th-TH/code>/td>td>Thai (Thailand)/td>/tr>tr>td>Tiếng Việt (Việt Nam)/td>td>code>vi-VN/code>/td>td>Vietnamese (Vietnam)/td>/tr>tr>td>Türkçe (Türkiye)/td>td>code>tr-TR/code>/td>td>Turkish (Turkey)/td>/tr>tr>td>Українська (Україна)/td>td>code>uk-UA/code>/td>td>Ukrainian (Ukraine)/td>/tr>tr>td>Urang (Indonesia)/td>td>code>su-ID/code>/td>td>Sundanese (Indonesia)/td>/tr>tr>td>اردو (بھارت)/td>td>code>ur-IN/code>/td>td>Urdu (India)/td>/tr>tr>td>اردو (پاکستان)/td>td>code>ur-PK/code>/td>td>Urdu (Pakistan)/td>/tr>tr>td>Ўзбек (Узбакистон)/td>td>code>uz-UZ/code>/td>td>Uzbek (Uzbekistan)/td>/tr>/tbody>/table>p>Mindful Feedback Supports the following respondent languages for survey response sentiment analysis (Most recent responses widget):/p>table>thead>tr>th>Language/th>th>languageCode/th>th>Language (English name)/th>/tr>/thead>tbody>tr>td>العربية/td>td>code>ar/code>/td>td>Arabic/td>/tr>tr>td>普通话 (中国大陆)/td>td>code>zh/code>/td>td>Chinese, Mandarin (Simplified)/td>/tr>tr>td>國語 (台灣)/td>td>code>zh-TW/code>/td>td>Chinese, Mandarin (Traditional)/td>/tr>tr>td>Deutsch (Deutschland)/td>td>code>de/code>/td>td>German (Germany)/td>/tr>tr>td>English/td>td>code>en/code>/td>td>English/td>/tr>tr>td>Español/td>td>code>es/code>/td>td>Spanish/td>/tr>tr>td>Français/td>td>code>fr/code>/td>td>French/td>/tr>tr>td>हिन्दी/td>td>code>hi/code>/td>td>Hindi/td>/tr>tr>td>Italiano/td>td>code>it/code>/td>td>Italian/td>/tr>tr>td>日本語/td>td>code>ja/code>/td>td>Japanese/td>/tr>tr>td>한국어/td>td>code>ko/code>/td>td>Korean/td>/tr>tr>td>Português/td>td>code>pt/code>/td>td>Portuguese/td>/tr>/tbody>/table>p>Mindful Feedback Supports the following respondent languages for text response sentiment analysis (Text response cloud widget):/p>table>thead>tr>th>Language/th>th>languageCode/th>th>Language (English name)/th>/tr>/thead>tbody>tr>td>Deutsch (Deutschland)/td>td>code>de/code>/td>td>German (Germany)/td>/tr>tr>td>English/td>td>code>en/code>/td>td>English/td>/tr>tr>td>Español/td>td>code>es/code>/td>td>Spanish/td>/tr>tr>td>Français/td>td>code>fr/code>/td>td>French/td>/tr>tr>td>Italiano/td>td>code>it/code>/td>td>Italian/td>/tr>tr>td>Português/td>td>code>pt/code>/td>td>Portuguese/td>/tr>/tbody>/table>h2 iddefaults>Defaults/h2>p>The default language value varies by region. The following table shows current default values by region URL./p>table>thead>tr>th>Region URL/th>th>Language Code/th>th>Language/th>/tr>/thead>tbody>tr>td>code>surveydynamix.com/code>/td>td>code>en-US/code>/td>td>English (United States)/td>/tr>tr>td>code>us2.surveydynamix.com/code>/td>td>code>en-US/code>/td>td>English (United States)/td>/tr>tr>td>code>us3.surveydynamix.com/code>/td>td>code>en-US/code>/td>td>English (United States)/td>/tr>tr>td>code>ca1.surveydynamix.com/code>/td>td>code>en-CA/code>/td>td>English (Canada)/td>/tr>tr>td>code>eu1.surveydynamix.com/code>/td>td>code>en-GB/code>/td>td>English (United Kingdom)/td>/tr>tr>td>code>au1.surveydynamix.com/code>/td>td>code>en-AU/code>/td>td>English (Australia)/td>/tr>tr>td>code>demo.surveydynamix.com/code>/td>td>code>en-AU/code>/td>td>English (Australia)/td>/tr>/tbody>/table>h1 iderrors>Errors/h1>p>The Mindful Feedback API uses the following error codes:/p>table>thead>tr>th>Error Code/th>th>Meaning/th>/tr>/thead>tbody>tr>td>code>400/code>/td>td>Bad Request -- Incorrectly formatted request. Check the API./td>/tr>tr>td>code>401/code>/td>td>Unauthorised -- Your API credentials are wrong or you do not have permission to access the requested resource/td>/tr>tr>td>code>404/code>/td>td>Not Found -- The requested resource could not be found/td>/tr>tr>td>code>405/code>/td>td>Method Not Allowed -- You tried to access an API endpoint with an invalid method/td>/tr>tr>td>code>409/code>/td>td>Not Modified Due to Existing Record Conflict -- You may have tried to add or update a resource in a way that would conflict with an existing resource, or you may have tried to delete a resource that is not in a deletable state./td>/tr>tr>td>code>410/code>/td>td>Gone -- The requested resource has been deleted/td>/tr>tr>td>code>429/code>/td>td>Rate limit exceeded -- You have sent too many requests in too short of a time-frame./td>/tr>tr>td>code>500/code>/td>td>Internal Server Error -- We had a problem with our server. Try again later./td>/tr>tr>td>code>503/code>/td>td>Service Unavailable -- We're temporarily offline for maintenance. Please try again later./td>/tr>/tbody>/table>      /div>      div classdark-box>          div classlang-selector>                a href# data-language-nameshell>cURL/a>                a href# data-language-namepython>python/a>                a href# data-language-namephp>php/a>                a href# data-language-namejavascript>javascript/a>          /div>      /div>    /div>  /body>/html>

Subdomains

Date	Domain	IP
us2.surveydynamix.com	2025-11-15	34.193.127.201
us3.surveydynamix.com	2025-10-15	52.34.246.63
apidocs.surveydynamix.com	2026-02-24	143.204.160.80
www.surveydynamix.com	2023-10-04	107.21.119.107

View on OTX | View on ThreatMiner

Data with thanks to AlienVault OTX, VirusTotal, Malwr and others. [Sitemap]

Domain > apidocs.surveydynamix.com

Is this malicious?

DNS Resolutions

Port 80

Port 443

Subdomains