@lirantal/typeform-client

a friendlier Typeform Node.js API client

About

@lirantal/typeform-client provides a friendlier access to pulling form data out of Typeform through their API. The official Typeform API client provides only raw access to the API and it is upon the consumer of their SDK to stich all the data. Some of the benefits that this friendlier interface to interface provides are:

• Looping through all the form survey results with the continuation token
• De-normalizing all the data such as form questions, and their responses, so everything is accessible from an aggregated interface.

Install

npm install --save @lirantal/typeform-client

Example

const {Form} = require('@lirantal/typeform-client')

// don't hard-code API keys inside the code. Load it via configuration
// management or another secure form. For convenience only this library
// also supports falling back to reading the API key from a TYPEFORM_API_KEY
// environment variable.
// (note: SECRETS IN ENVIRONMENT VARIABLES ARE HIGHLY DISCOURAGED)
const apiKey = config.apiKey
// provide the form id for the typeform survey, which is present as part
// of a URL resource
const formId = config.formId

const typeform = new Form({apiKey: apiKey})
const form = await typeform.fetchFormResponses(formId)

// form is an object with all the form responses, and each question field is
// populated with all the answers collected from the survey

Supported fields

The following form fields are currently supported to extract:

• Yes/No questions (yes_no)
• Opinion scale questions (opinion_scale)
• All variants of multiple choice questions, including an 'other' field, and single vs multiple answers (multiple_choice)
• Free text questions (short_text)

Related

typeform-export-excel - Export a Typeform survey questionnaire to an Excel format

Contributing

Please consult CONTIRBUTING for guidelines on contributing to this project.

Author

typeform-export-excel © Liran Tal, Released under the Apache-2.0 License.