Note: The below article uses examples of accessing the Decipher API from a Unix system that has the Beacon library package installed. Click here to learn more about accessing the Decipher REST API.
You can use the following API calls to perform a variety of survey data input and output tasks. Click any call name to view more information.
|Download Data||Downloads all specified survey data.|
|Retrieve Datamap||Retrieves the survey datamap.|
|Retrieve Layouts||Retrieves a list of all created data layouts.|
|Modify Markers||Updates participant survey markers as specified.|
|Get Campaigns||Retrieves information for all email campaigns sent for the survey from the “Campaigns” tab of the Response Summary.|
Note: By default, API calls in the shell output information directly to the console screen. If you want to reuse that output, you will want to save it to a file.
Note: If you are using a web call method to access the API, you will need to have a way of providing your API key. Click here for more information.
Note: You will need to change tes.decipherinc.com to the domain that you use to log into the Decipher platform.
Viewing Returned Data
You can use the global
select parameter to retrieve a subset of any GET call's returned data. You can pass in
select as an argument set to a comma-separated list of properties to return.
activewill only retrieve these three specific fields when calling in the User List API:
beacon get rh/users select=id,login,active
select parameter should only be used on GET method API calls to filter information retrieved via an API call, and not information that you send (e.g., via a PUT or POST method) to Decipher.