lb_bitstream 1.0.2 lb_bitstream: ^1.0.2 copied to clipboard
Logbot bitstream client to be used for API requests to Logbot Graphite Bitstream APIs
Logbot Bitstream SDK for Flutter #
This is a package that provides access to graphite bitstream APIs
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Build package: org.openapitools.codegen.languages.DartClientCodegen
Requirements #
Dart 2.17 or later
Installation & Usage #
Add the dependencies from pub.dev:
dependencies:
lb_auth:
lb_bitstream:
lb_auth
is always required to make authorized calls to the APIs.
To use the SDK on you application see the example below:
import 'package:lb_auth/lb_auth.dart';
import 'package:lb_bitstream/lb_bitstream.dart';
class Example {
Future<void> run() async {
/// Initialize Logbot SDK by logging in with Logbot Credentials
await LogbotAuth.init(LogbotCredentials(
username: username,
password: password,
clientId: clientId,
clientSecret: clientSecret,
));
/// Now you can use every API included on the SDK
/// for example:
List<String>? response = await LogbotBitstream.metrics.index();
}
}
Tests #
To run all tests:
flutter test
Documentation for API Endpoints #
All URIs are relative to https://platform.logbotiot.cloud/bitstream
Class | Method | HTTP request | Description |
---|---|---|---|
MetricsApi | index | GET /metrics/index.json | Lists all the metrics |
RenderApi | render | GET /render | Timeseries values |
TagsApi | autoCompleteTags | GET /tags/autoComplete/tags | List all tags |
TagsApi | autoCompleteValues | GET /tags/autoComplete/values | Find all the values of the searched tag |
TagsApi | find | GET /find | Find a metric |
Documentation For Models #
Author #
Logbot SRL info@logbot.cloud