Download survey metadata — retrieve_survey_metadata • peskas.timor.data.pipeline

Download survey metadata

Usage

retrieve_survey_metadata(id = NULL, token = NULL, api = "kobohr")

Arguments

id: survey id. Usually a 6 digit number. See this support page for an example on how this can be obtained
token: access token for the account e.g. "Token XXXXXXX"
api: Either "kobo", "kobohr", "ona", or a custom (full) URL. API URLs are made available for KoBo Toolbox ("kobo", https://kc.kobotoolbox.org/api/v1/), KoBo Humanitarian Response ("kobohr", https://kc.humanitarianresponse.info/api/v1/), Ona ("ona", https://api.ona.io/api/v1/) and Unhcr ("unhcr", https://kobocat.unhcr.org/api/v1/) . For your own installation, or other installations using the same API but accessed at a different URL, enter the full URL.

Value

A list with survey metadata

Examples

if (FALSE) { # \dontrun{
# It's only possible to donwload survey metadata with the account Token
retrieve_survey_metadata(753491, token = "123XXXXXX")
} # }