# fintracker_api.api.MetricsApi

## Load the API package
```dart
import 'package:fintracker_api/api.dart';
```

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**metricsDataQuality**](MetricsApi.md#metricsdataquality) | **GET** /api/v1/data-quality | Data Quality
[**metricsRefresh**](MetricsApi.md#metricsrefresh) | **POST** /api/v1/metrics/refresh | Refresh
[**metricsStatus**](MetricsApi.md#metricsstatus) | **GET** /api/v1/metrics/status | Status


# **metricsDataQuality**
> List<DataQualityRow> metricsDataQuality()

Data Quality

Findings of the latest refresh, most serious first.

### Example
```dart
import 'package:fintracker_api/api.dart';

final api = FintrackerApi().getMetricsApi();

try {
    final response = api.metricsDataQuality();
    print(response);
} on DioException catch (e) {
    print('Exception when calling MetricsApi->metricsDataQuality: $e\n');
}
```

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

### Return type

[**List&lt;DataQualityRow&gt;**](DataQualityRow.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **metricsRefresh**
> SyncJobOut metricsRefresh()

Refresh

Queue a rebuild of every metric_* table; the worker runs it. Poll `/metrics/status` until `refreshing` is false.  A request while one is already waiting shares it. One that arrives while a rebuild is RUNNING queues another, because the running one may have read the data before the change that prompted this call.

### Example
```dart
import 'package:fintracker_api/api.dart';

final api = FintrackerApi().getMetricsApi();

try {
    final response = api.metricsRefresh();
    print(response);
} on DioException catch (e) {
    print('Exception when calling MetricsApi->metricsRefresh: $e\n');
}
```

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

### Return type

[**SyncJobOut**](SyncJobOut.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **metricsStatus**
> MetricsStatusOut metricsStatus()

Status

When the metric tables were last rebuilt, whether they are one consistent snapshot, and whether another rebuild is on its way.

### Example
```dart
import 'package:fintracker_api/api.dart';

final api = FintrackerApi().getMetricsApi();

try {
    final response = api.metricsStatus();
    print(response);
} on DioException catch (e) {
    print('Exception when calling MetricsApi->metricsStatus: $e\n');
}
```

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

### Return type

[**MetricsStatusOut**](MetricsStatusOut.md)

### Authorization

[HTTPBearer](../README.md#HTTPBearer)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/problem+json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)