2.0.0 • Published 3 years ago
bedrock-stats v2.0.0
bedrock-stats
Available Storage APIs
API Reference
bedrock-stats
- bedrock-stats
- .getMonitorIds(options) ⇒ Promise.<Array.<string>>
- .getReports(options) ⇒ Promise.<Object>
bedrock-stats.getMonitorIds(options) ⇒ Promise.<Array.<string>>
Get all known monitor IDs.
Kind: static method of bedrock-stats
Returns: Promise.<Array.<string>> - The monitor IDs.
Throws:
- BedrockError Will throw a
NotFoundErroron an unknown storage API.
| Param | Type | Description |
|---|---|---|
| options | Object | The options to use. |
| options.storageApi | string | The storage API to use. |
bedrock-stats.getReports(options) ⇒ Promise.<Object>
Get a stats reports matching the query.
Kind: static method of bedrock-stats
Returns: Promise.<Object> - The stats report.
Throws:
- BedrockError Will throw a
NotFoundErroron an unknown storage API.
| Param | Type | Description |
|---|---|---|
| options | Object | The options to use. |
| options.query | Object | The query passed to the storage API. |
| options.storageApi | string | The storage API to use. |