# surveymonkey-fields

> A node.js wrapper for the SurveyMonkey API.

Latest version **0.0.5** (published 2013-11-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install surveymonkey-fields
pnpm add surveymonkey-fields
yarn add surveymonkey-fields
bun add surveymonkey-fields
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2013-11-15 |
| First published | 2013-11-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jeff Zabel |
| Maintainers | cking4 |

## Links

- npm: https://www.npmjs.com/package/surveymonkey-fields
- Repository: https://github.com/ChristopherKing/node-surveymonkey
- Issues: https://github.com/ChristopherKing/node-surveymonkey/issues
- npm.io page: https://npm.io/package/surveymonkey-fields

## Dependencies (1)

- [request](https://npm.io/package/request.md) 2.x.x

## Recent versions

- 0.0.5 (latest) — 2013-11-15

## README

# node-surveymonkey

A node.js library for the SurveyMonkey API

_node-surveymonkey_ exposes the following features of the SurveyMonkey API to your node.js application:
 
 * SurveyMonkey API (Versions v2)

Further information on the SurveyMonkey API and its features is available at [https://developer.surveymonkey.com](https://developer.surveymonkey.com)

## Installation

Installing using npm (node package manager):

    npm install surveymonkey
    
If you don't have npm installed or don't want to use it:

    cd ~/.node_libraries
    git clone git@github.com:Datahero/node-surveymonkey.git

Please note that parts of _node-surveymonkey_ depend on [request](http://github.com/mikeal/request) by [Mikeal Rogers](http://github.com/mikeal). This library needs to be installed for the API to work. Additionally [node-querystring](http://github.com/visionmedia/node-querystring) is required. If you are using npm all dependencies should be automagically resolved for you.

## Usage

Information on how to use the SurveyMonkey APIs can be found below. Further information on the API methods available can be found at [https://developer.surveymonkey.com](https://developer.surveymonkey.com). You can also find further information on how to obtain an API key, and/or OAuth2 in your SurveyMonkey account and much more on the SurveyMonkey API pages.

### SurveyMonkey API

_SurveyMonkeyAPI_ takes two arguments. The first argument is your API key, which you can find in your SurveyMonkey Account. The second argument is an options object which can contain the following options:

 * `version` The API version to use. Defaults to v2.
 * `secure` Whether or not to use secure connections over HTTPS (true/false). Defaults to false.
 * `userAgent` Custom User-Agent description to use in the request header.
 
The callback function for each API method gets two arguments. The first one is an error object which is null when no error occured, the second one an object with all information retrieved as long as no error occured.

Example:

```javascript
var SurveyMonkeyAPI = require('surveymonkey').SurveyMonkeyAPI;

var apiKey = 'Your SurveyMonkey API Key';

try { 
    var api = new SurveyMonkeyAPI(apiKey, { version : 'v2', secure : false });
} catch (error) {
    console.log(error.message);
}

api.getSurveyList({ title: 'some_title', page_size: 25 }, function (error, data) {
    if (error)
        console.log(error.message);
    else
        console.log(JSON.stringify(data)); // Do something with your data!
});

```
  
## License

_node-surveymonkey_ is licensed under the MIT License. (See LICENSE)

---
_Source: https://npm.io/package/surveymonkey-fields · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._