# 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](https://github.com/swagger-api/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](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
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**](docs/FiltersApi.md#filtersBrowseGet) | **GET** /filters/browse | List of all filters & values
*PollfishInsightsApi.FiltersApi* | [**filtersGet**](docs/FiltersApi.md#filtersGet) | **GET** /filters | List of filters
*PollfishInsightsApi.FiltersApi* | [**filtersIdDelete**](docs/FiltersApi.md#filtersIdDelete) | **DELETE** /filters/{id} | Delete the filter
*PollfishInsightsApi.FiltersApi* | [**filtersIdPut**](docs/FiltersApi.md#filtersIdPut) | **PUT** /filters/{id} | Update a filter
*PollfishInsightsApi.FiltersApi* | [**filtersPost**](docs/FiltersApi.md#filtersPost) | **POST** /filters | Create a new filter
*PollfishInsightsApi.FiltersApi* | [**filtersSearchqueryqueryGet**](docs/FiltersApi.md#filtersSearchqueryqueryGet) | **GET** /filters/search?query={query} | Search for filters & values
*PollfishInsightsApi.MetricsApi* | [**metricsGet**](docs/MetricsApi.md#metricsGet) | **GET** /metrics | List of metrics
*PollfishInsightsApi.MetricsApi* | [**metricsIdDelete**](docs/MetricsApi.md#metricsIdDelete) | **DELETE** /metrics/{id} | Remove a metric
*PollfishInsightsApi.MetricsApi* | [**metricsIdPut**](docs/MetricsApi.md#metricsIdPut) | **PUT** /metrics/{id} | Update a metric
*PollfishInsightsApi.MetricsApi* | [**metricsPost**](docs/MetricsApi.md#metricsPost) | **POST** /metrics | Create a new metric


## Documentation for Models

 - [PollfishInsightsApi.BodyMetric](docs/BodyMetric.md)
 - [PollfishInsightsApi.Error](docs/Error.md)
 - [PollfishInsightsApi.Filter](docs/Filter.md)
 - [PollfishInsightsApi.Filter1](docs/Filter1.md)
 - [PollfishInsightsApi.Filters](docs/Filters.md)
 - [PollfishInsightsApi.FiltersBrowse](docs/FiltersBrowse.md)
 - [PollfishInsightsApi.FiltersBrowseCategories](docs/FiltersBrowseCategories.md)
 - [PollfishInsightsApi.FiltersBrowseTaxonomies](docs/FiltersBrowseTaxonomies.md)
 - [PollfishInsightsApi.FiltersBrowseValues](docs/FiltersBrowseValues.md)
 - [PollfishInsightsApi.FiltersFilters](docs/FiltersFilters.md)
 - [PollfishInsightsApi.FiltersPut](docs/FiltersPut.md)
 - [PollfishInsightsApi.FiltersSearch](docs/FiltersSearch.md)
 - [PollfishInsightsApi.FiltersSearchResults](docs/FiltersSearchResults.md)
 - [PollfishInsightsApi.FiltersSearchTaxonomy](docs/FiltersSearchTaxonomy.md)
 - [PollfishInsightsApi.FiltersValues](docs/FiltersValues.md)
 - [PollfishInsightsApi.Metrics](docs/Metrics.md)
 - [PollfishInsightsApi.MetricsData](docs/MetricsData.md)
 - [PollfishInsightsApi.MetricsMetrics](docs/MetricsMetrics.md)
 - [PollfishInsightsApi.MetricsPost](docs/MetricsPost.md)
 - [PollfishInsightsApi.MetricsPostMetrics](docs/MetricsPostMetrics.md)
 - [PollfishInsightsApi.MetricsSeries](docs/MetricsSeries.md)


## Documentation for Authorization

 All endpoints do not require authorization.