Yale Qualtrics
Overview
Qualtrics REST API allows you to query the Qualtrics system using a simple URL syntax.
How to Generate an API Key (Token)
1. Go to Yale Qualtrics and log in with your NetID.
2. Click on your name on the top right and go to Account Settings.
3. Click Qualtrics ID then click generate token under API.
Required Parameters
The following parameters are required for all requests:
|
Parameter |
Example |
Description |
|---|---|---|
|
Request |
getSurveys | The name of the API call to be made |
|
User |
jl2463#yalesurvey |
Qualtrics username. |
| Token | c1ag3eacqy5gwv2hJKVOg7u0NN5MBCn96TkP4IlR | Qualtrics API token. |
| Format | JSON | The format of the response. Valid value are XML, JSON or JSONP unless otherwise noted. |
| Version | 2.4 | The version of the API to use. |
| JSONPCallback | Only required when Format is JSONP. The JSONP technique may be used by specifying a JavaScript callback. |
Format Parameters
Parameters specific to a particular format.
|
Parameter |
Format |
Description |
|---|---|---|
|
JSONPCallback |
JSONP | Required. The callback to be used when applying the JSONP technique. |
|
JSONPrettyPrint |
JSON, JSONP |
Optional. Outputs JSON so that it is more readable. |
Example Response from getSurveys Request:
XML:
<XML>
<Meta>
<Status>Success</Status>
<Debug/>
</Meta>
<Result>
<Surveys>
<element id=”0”>
<SurveyType>SV</SurveyType>
<SurveyID>SV_2nsQoJceN4iwddb</SurveyID>
<SurveyName>Test Survey</SurveyName>
<SurveyOwnerID>UR_8fdxXTkzGSjdwA5</SurveyOwnerID>
<SurveyStatus>Active</SurveyStatus>
<SurveyStartDate>0000-00-00 00:00:00</SurveyStartDate>
<SurveyExpirationDate>0000-00-00 00:00:00</SurveyExpirationDate>
<SurveyCreationDate>2015-02-13 09:15:31</SurveyCreationDate>
<CreatorID>UR_8fdxXTkzGSjdwA5</CreatorID>
<LastModified>2015-02-13 09:17:59</LastModified>
<LastActivated>2015-02-13 09:17:59</LastActivated>
<UserFirstName>Jemin</UserFirstName>
<UserLastName>Lee</UserLastName>
</element>
</Surveys>
</Result>
</XML>
JSON:
{
“Meta”: {
”Status”: “Success”,
”Debug”: “”
},
“Result”: {
”Surveys”: [
{
”SurveyType”: “SV”,
”SurveyID”: “SV_2nsQoJceN4iwddb”,
”SurveyName”: “Test Survey”,
”SurveyOwnerID”: “UR_8fdxXTkzGSjdwA5”,
”SurveyStatus”: “Active”,
”SurveyStartDate”: “0000-00-00 00:00:00”,
”SurveyExpirationDate”: “0000-00-00 00:00:00”,
”SurveyCreationDate”: “2015-02-13 09:15:31”,
”CreatorID”: “UR_8fdxXTkzGSjdwA5”,
”LastModified”: “2015-02-13 09:17:59”,
”LastActivated”: “2015-02-13 09:17:59”,
”UserFirstName”: “Jemin”,
”UserLastName”: “Lee”
}
]
}
}
Set up an outside program to interface directly with Qualtrics. Access the current Qualtrics API documentation and learn how to locate Qualtrics IDs using Developer Tools.
APIs