MetricsApi.md

core_openapi.api.MetricsApi

Load the API package

import 'package:pieces_os_client/api.dart';

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

Method	HTTP request	Description
getMetricsFormats	GET /metrics/formats	/metrics/formats [GET]
metricsFormatsOrdered	GET /metrics/formats/ordered	/metrics/formats/ordered [GET]

getMetricsFormats

FormatsMetrics getMetricsFormats()

/metrics/formats [GET]

This is going to get a snapshot of our FormatsMetrics

Example

import 'package:pieces_os_client/api.dart';

final api_instance = MetricsApi();

try {
    final result = api_instance.getMetricsFormats();
    print(result);
} catch (e) {
    print('Exception when calling MetricsApi->getMetricsFormats: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

FormatsMetrics

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

metricsFormatsOrdered

OrderedMetrics metricsFormatsOrdered()

/metrics/formats/ordered [GET]

This will return a list of code formats in desc order from most to least formats uploaded.

Example

import 'package:pieces_os_client/api.dart';

final api_instance = MetricsApi();

try {
    final result = api_instance.metricsFormatsOrdered();
    print(result);
} catch (e) {
    print('Exception when calling MetricsApi->metricsFormatsOrdered: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

OrderedMetrics

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]