Pollfish_insights_api NPM

pollfish_insights_api

PollfishInsightsApi - JavaScript client for pollfish_insights_api Provide market insights with Pollfish Insights API This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.1
Package version: 1.0.1
Build date: 2016-08-01T10:47:56.593Z
Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install pollfish_insights_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var PollfishInsightsApi = require('pollfish_insights_api');

var api = new PollfishInsightsApi.FiltersApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.filtersBrowseGet(callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/api/v1/insights

Class	Method	HTTP request	Description
PollfishInsightsApi.FiltersApi	filtersBrowseGet	GET /filters/browse	List of all filters & values
PollfishInsightsApi.FiltersApi	filtersGet	GET /filters	List of filters
PollfishInsightsApi.FiltersApi	filtersIdDelete	DELETE /filters/{id}	Delete the filter
PollfishInsightsApi.FiltersApi	filtersIdPut	PUT /filters/{id}	Update a filter
PollfishInsightsApi.FiltersApi	filtersPost	POST /filters	Create a new filter
PollfishInsightsApi.FiltersApi	filtersSearchqueryqueryGet	GET /filters/search?query={query}	Search for filters & values
PollfishInsightsApi.MetricsApi	metricsGet	GET /metrics	List of metrics
PollfishInsightsApi.MetricsApi	metricsIdDelete	DELETE /metrics/{id}	Remove a metric
PollfishInsightsApi.MetricsApi	metricsIdPut	PUT /metrics/{id}	Update a metric
PollfishInsightsApi.MetricsApi	metricsPost	POST /metrics	Create a new metric