How to Export Survey Data Using the Export cURL Command
Like Ripple’s internal Export Tool, the Export cURL Command can be used to export survey data in bulk. This method enables faster access to submitted survey responses and allows for seamless transfer into third-party systems such as Electronic Data Capture (EDC) platforms, Clinical Trial Management Systems (CTMS), or CRM systems.
What You’ll Need
Before you begin, make sure you have the following:
-
Ripple Site URL
-
Authorization Key
-
Study ID
-
Survey ID
-
Order of the survey in the Saved Surveys list
-
Export start date for the survey data (formatted as
YYYY-MM-DD
)
How to Export Survey Data
To include survey data in your Export cURL Command, you’ll need to add three key components:
1. Set the Start Date for Survey Exports
Add this to your command:
surveyExportSince=YYYY-MM-DD
Replace YYYY-MM-DD
with the earliest date from which you want to begin exporting survey responses.
2. Specify the Survey’s Order in the Saved Surveys List
Ripple identifies each survey by its order in your Saved Surveys list. You’ll add the following to your command:
survey#
-
#
is the survey’s index number, starting at0
How to Find the Survey Order:
-
Navigate to the Saved Surveys list in Ripple.
-
Count from the top—the first survey is
survey0
(red box), the second issurvey1
, the third issurvey2
, and so on.
3. Locate and Add the Survey’s ID
-
Open the desired survey.
-
Look at the URL in your browser.
-
The first string in the URL is the Study ID
-
The second string is the Survey ID (green box)
-
Example Export cURL Command (for Mac):
curl 'https://yourlab.ripplescience.com/v1/export' \
--header 'Authorization: Basic YourAuthorizationKey' \
--data-raw 'export-type=YourStudyID&export-timezone=America/New_York&surveyExportSince=2024-01-01&survey0=abcd1234efgh5678&firstName=on&lastName=on&surveyStatus=on' > SurveyExport.csv
Windows Users – Important Formatting Note
🟡 Note for Windows Users:
If you’re using a Windows device:
-
Replace all single quotes (
'
) with double quotes ("
) -
Remove any backslashes (
\
) used for line breaks
Summary
Step | What to Do |
---|---|
Export Start Date | surveyExportSince=YYYY-MM-DD |
Survey Order | Determine from the Saved Surveys list (first = survey0 ) |
Survey ID | Found in the URL of the open survey |
Formatting for Windows | Use double quotes and remove line-break backslashes |