fin-tracker/app/packages/api_client/doc/AnalyticsApi.md

# fintracker_api.api.AnalyticsApi

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

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**analyticsAllocation**](AnalyticsApi.md#analyticsallocation) | **GET** /api/v1/analytics/allocation | Allocation
[**analyticsCashflowBroker**](AnalyticsApi.md#analyticscashflowbroker) | **GET** /api/v1/analytics/cashflow-broker | Cashflow Broker
[**analyticsHoldings**](AnalyticsApi.md#analyticsholdings) | **GET** /api/v1/analytics/holdings | Holdings
[**analyticsOverview**](AnalyticsApi.md#analyticsoverview) | **GET** /api/v1/analytics/overview | Overview
[**analyticsReturns**](AnalyticsApi.md#analyticsreturns) | **GET** /api/v1/analytics/returns | Returns
[**analyticsScopes**](AnalyticsApi.md#analyticsscopes) | **GET** /api/v1/analytics/scopes | Scopes
[**analyticsSummary**](AnalyticsApi.md#analyticssummary) | **GET** /api/v1/analytics/summary | Summary
[**analyticsValueSeries**](AnalyticsApi.md#analyticsvalueseries) | **GET** /api/v1/analytics/value-series | Value Series


# **analyticsAllocation**
> List<AllocationBucket> analyticsAllocation(scope, dimension)

Allocation

Buckets of one dimension (or all four), largest first.

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

final api = FintrackerApi().getAnalyticsApi();
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>
final AllocationDimension dimension = ; // AllocationDimension | 

try {
    final response = api.analyticsAllocation(scope, dimension);
    print(response);
} on DioException catch (e) {
    print('Exception when calling AnalyticsApi->analyticsAllocation: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']
 **dimension** | [**AllocationDimension**](.md)|  | [optional] 

### Return type

[**List&lt;AllocationBucket&gt;**](AllocationBucket.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)

# **analyticsCashflowBroker**
> List<CashFlowBrokerMonth> analyticsCashflowBroker(scope)

Cashflow Broker

Money moved across the brokerage boundary, by month: the other half of cash flow that `metric_cash_flow_monthly` (ZenMoney spending) does not cover.

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

final api = FintrackerApi().getAnalyticsApi();
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']

### Return type

[**List&lt;CashFlowBrokerMonth&gt;**](CashFlowBrokerMonth.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)

# **analyticsHoldings**
> List<HoldingOut> analyticsHoldings(scope)

Holdings

Open positions, most valuable first; unpriced ones last with null values.

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

final api = FintrackerApi().getAnalyticsApi();
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']

### Return type

[**List&lt;HoldingOut&gt;**](HoldingOut.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)

# **analyticsOverview**
> List<ScopeCardOut> analyticsOverview()

Overview

One card per scope for the home screen, in a single round trip.  `all` first, then the portfolios, then the accounts by value. A scope holding nothing at all is left out: a card of zeros is noise, not an answer.

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

final api = FintrackerApi().getAnalyticsApi();

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

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

### Return type

[**List&lt;ScopeCardOut&gt;**](ScopeCardOut.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)

# **analyticsReturns**
> List<ReturnsOut> analyticsReturns(scope)

Returns

XIRR and TWR per period, shortest first.

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

final api = FintrackerApi().getAnalyticsApi();
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']

### Return type

[**List&lt;ReturnsOut&gt;**](ReturnsOut.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)

# **analyticsScopes**
> List<ScopeOut> analyticsScopes()

Scopes

Every set of accounts the metrics were built for.

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

final api = FintrackerApi().getAnalyticsApi();

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

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

### Return type

[**List&lt;ScopeOut&gt;**](ScopeOut.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)

# **analyticsSummary**
> SummaryOut analyticsSummary(scope)

Summary

One screen's worth: the latest day, the totals it adds up to, and the returns.

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

final api = FintrackerApi().getAnalyticsApi();
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']

### Return type

[**SummaryOut**](SummaryOut.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)

# **analyticsValueSeries**
> List<ValueDay> analyticsValueSeries(scope, from, to)

Value Series

Daily portfolio value; defaults to the last 365 days.

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

final api = FintrackerApi().getAnalyticsApi();
final String scope = scope_example; // String | all | account:<id> | portfolio:<id>
final DateTime from = 2013-10-20; // DateTime | 
final DateTime to = 2013-10-20; // DateTime | 

try {
    final response = api.analyticsValueSeries(scope, from, to);
    print(response);
} on DioException catch (e) {
    print('Exception when calling AnalyticsApi->analyticsValueSeries: $e\n');
}
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **scope** | **String**| all | account:<id> | portfolio:<id> | [optional] [default to 'all']
 **from** | **DateTime**|  | [optional] 
 **to** | **DateTime**|  | [optional] 

### Return type

[**List&lt;ValueDay&gt;**](ValueDay.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)