start_export | R Documentation |
Has server-side side-effect of starting an export job for the target questionnaire. The function parameters provide a way to describe which interviews should be exported and for which questionnaire.
start_export( qnr_id, export_type, interview_status = "All", from = "", to = "", access_token = "", refresh_token = "", storage_type = "", translation_id = "", include_meta = TRUE, server = Sys.getenv("SUSO_SERVER"), workspace = Sys.getenv("SUSO_WORKSPACE"), user = Sys.getenv("SUSO_USER"), password = Sys.getenv("SUSO_PASSWORD") )
qnr_id |
Character. Questionnaire ID. Format: |
export_type |
Character. Type of data to export. Values: |
interview_status |
Character. Status of interviews to export. Values: |
from |
Character. Start date for interviews to export. date-time, UTC |
to |
Character. End date for interviews to export. date-time, UTC |
access_token |
Access token to external storage. Relevant only if external cloud storage is destination for the export file. |
refresh_token |
Refresh token to external storage.Relevant only if external cloud storage is destination for the export file. |
storage_type |
Character. External storage type, if relevant. Values: |
translation_id |
Character. Translation ID for variable and value labels to include in export files. |
include_meta |
Logical. If |
server |
Character. Full server web address (e.g., |
workspace |
Character. Name of the workspace whose export jobs to start. In workspace list, value of |
user |
Character. API user name |
password |
Character. API password |
Wrapper for POST /api/v2/export
endpoint
Job ID of export process started.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.