111 lines
3.1 KiB
Markdown
111 lines
3.1 KiB
Markdown
# manager_api_new.api.StatsApi
|
|
|
|
## Load the API package
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
```
|
|
|
|
All URIs are relative to *https://localhost:5001*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**statsGetSummary**](StatsApi.md#statsgetsummary) | **GET** /api/Stats/summary |
|
|
[**statsTrackEvent**](StatsApi.md#statstrackevent) | **POST** /api/Stats/event |
|
|
|
|
|
|
# **statsGetSummary**
|
|
> StatsSummaryDTO statsGetSummary(instanceId, from, to, appType)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = StatsApi();
|
|
final instanceId = instanceId_example; // String |
|
|
final from = 2013-10-20T19:20:30+01:00; // DateTime |
|
|
final to = 2013-10-20T19:20:30+01:00; // DateTime |
|
|
final appType = appType_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.statsGetSummary(instanceId, from, to, appType);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling StatsApi->statsGetSummary: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**instanceId** | **String**| | [optional]
|
|
**from** | **DateTime**| | [optional]
|
|
**to** | **DateTime**| | [optional]
|
|
**appType** | **String**| | [optional]
|
|
|
|
### Return type
|
|
|
|
[**StatsSummaryDTO**](StatsSummaryDTO.md)
|
|
|
|
### Authorization
|
|
|
|
[bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/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)
|
|
|
|
# **statsTrackEvent**
|
|
> statsTrackEvent(visitEventDTO)
|
|
|
|
|
|
|
|
### Example
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
// TODO Configure API key authorization: apikey
|
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('apikey').apiKey = 'YOUR_API_KEY';
|
|
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
|
|
//defaultApiClient.getAuthentication<ApiKeyAuth>('apikey').apiKeyPrefix = 'Bearer';
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = StatsApi();
|
|
final visitEventDTO = VisitEventDTO(); // VisitEventDTO |
|
|
|
|
try {
|
|
api_instance.statsTrackEvent(visitEventDTO);
|
|
} catch (e) {
|
|
print('Exception when calling StatsApi->statsTrackEvent: $e\n');
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**visitEventDTO** | [**VisitEventDTO**](VisitEventDTO.md)| |
|
|
|
|
### Return type
|
|
|
|
void (empty response body)
|
|
|
|
### Authorization
|
|
|
|
[apikey](../README.md#apikey), [bearer](../README.md#bearer)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/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)
|
|
|