# PollfishInsightsApi.FiltersApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**filtersBrowseGet**](FiltersApi.md#filtersBrowseGet) | **GET** /filters/browse | List of all filters & values
[**filtersGet**](FiltersApi.md#filtersGet) | **GET** /filters | List of filters
[**filtersIdDelete**](FiltersApi.md#filtersIdDelete) | **DELETE** /filters/{id} | Delete the filter
[**filtersIdPut**](FiltersApi.md#filtersIdPut) | **PUT** /filters/{id} | Update a filter
[**filtersPost**](FiltersApi.md#filtersPost) | **POST** /filters | Create a new filter
[**filtersSearchqueryqueryGet**](FiltersApi.md#filtersSearchqueryqueryGet) | **GET** /filters/search?query={query} | Search for filters & values


<a name="filtersBrowseGet"></a>
# **filtersBrowseGet**
> FiltersBrowse filtersBrowseGet()

List of all filters &amp; values

The filters/browse endpoint helps explore all possible filters &amp; values 

### Example
```javascript
var PollfishInsightsApi = require('pollfish_insights_api');

var apiInstance = new PollfishInsightsApi.FiltersApi();

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

### Parameters
This endpoint does not need any parameter.

### Return type

[**FiltersBrowse**](FiltersBrowse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="filtersGet"></a>
# **filtersGet**
> Filters filtersGet()

List of filters

The filters endpoints returns an object with a list of all filters 

### Example
```javascript
var PollfishInsightsApi = require('pollfish_insights_api');

var apiInstance = new PollfishInsightsApi.FiltersApi();

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

### Parameters
This endpoint does not need any parameter.

### Return type

[**Filters**](Filters.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="filtersIdDelete"></a>
# **filtersIdDelete**
> filtersIdDelete(id)

Delete the filter

The filters endpoint removes a filter and returns a status 

### Example
```javascript
var PollfishInsightsApi = require('pollfish_insights_api');

var apiInstance = new PollfishInsightsApi.FiltersApi();

var id = "id_example"; // String | the filter id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.filtersIdDelete(id, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| the filter id | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="filtersIdPut"></a>
# **filtersIdPut**
> FiltersPut filtersIdPut(id, filter)

Update a filter

The filters endpoint updates a filter and returns the newly updated filter 

### Example
```javascript
var PollfishInsightsApi = require('pollfish_insights_api');

var apiInstance = new PollfishInsightsApi.FiltersApi();

var id = "id_example"; // String | the filter id

var filter = new PollfishInsightsApi.Filter1(); // Filter1 | update filter


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.filtersIdPut(id, filter, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| the filter id | 
 **filter** | [**Filter1**](Filter1.md)| update filter | 

### Return type

[**FiltersPut**](FiltersPut.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="filtersPost"></a>
# **filtersPost**
> Filters filtersPost(filter)

Create a new filter

The filters endpoint create a new filter and returns the newly created filter 

### Example
```javascript
var PollfishInsightsApi = require('pollfish_insights_api');

var apiInstance = new PollfishInsightsApi.FiltersApi();

var filter = new PollfishInsightsApi.Filter(); // Filter | create filter


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **filter** | [**Filter**](Filter.md)| create filter | 

### Return type

[**Filters**](Filters.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="filtersSearchqueryqueryGet"></a>
# **filtersSearchqueryqueryGet**
> FiltersSearch filtersSearchqueryqueryGet(query)

Search for filters &amp; values

The filters/search endpoint searches for specific filters/values 

### Example
```javascript
var PollfishInsightsApi = require('pollfish_insights_api');

var apiInstance = new PollfishInsightsApi.FiltersApi();

var query = "query_example"; // String | the query search term


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **query** | **String**| the query search term | 

### Return type

[**FiltersSearch**](FiltersSearch.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json