# PollfishInsightsApi.MetricsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**metricsGet**](MetricsApi.md#metricsGet) | **GET** /metrics | List of metrics
[**metricsIdDelete**](MetricsApi.md#metricsIdDelete) | **DELETE** /metrics/{id} | Remove a metric
[**metricsIdPut**](MetricsApi.md#metricsIdPut) | **PUT** /metrics/{id} | Update a metric
[**metricsPost**](MetricsApi.md#metricsPost) | **POST** /metrics | Create a new metric


<a name="metricsGet"></a>
# **metricsGet**
> Metrics metricsGet()

List of metrics

The metrics endpoint returns a list with all the current metrics that the user added in his dashboard 

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

var apiInstance = new PollfishInsightsApi.MetricsApi();

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

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

### Return type

[**Metrics**](Metrics.md)

### Authorization

No authorization required

### HTTP request headers

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

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

Remove a metric

The metrics endpoints removes a metric and returns a confirmation message 

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

var apiInstance = new PollfishInsightsApi.MetricsApi();

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


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

### Parameters

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

### Return type

[**Metrics**](Metrics.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="metricsIdPut"></a>
# **metricsIdPut**
> Metrics metricsIdPut(id, metric)

Update a metric

The metrics endpoint updates a metric and returns the newly updated metric 

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

var apiInstance = new PollfishInsightsApi.MetricsApi();

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

var metric = new PollfishInsightsApi.BodyMetric(); // BodyMetric | update metric


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

### Parameters

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

### Return type

[**Metrics**](Metrics.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="metricsPost"></a>
# **metricsPost**
> MetricsPost metricsPost()

Create a new metric

The metrics endpoint create a new metric and returns the newly created metric 

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

var apiInstance = new PollfishInsightsApi.MetricsApi();

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

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

### Return type

[**MetricsPost**](MetricsPost.md)

### Authorization

No authorization required

### HTTP request headers

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