Skip to content

Commit eb0c8c5

Browse files
committed
Add link to metrics to README
Signed-off-by: cwasicki <[email protected]>
1 parent aa9de64 commit eb0c8c5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ client = ReportingApiClient(server_url=SERVER_URL, auth_key=AUTH_KEY, sign_secre
6868
### Query metrics for a single microgrid and component
6969

7070
This method supports:
71-
- Selecting specific `microgrid_id` and `component_id`
72-
- Choosing one or more `metrics` to retrieve
73-
- Defining a time range with `start_time` and `end_time`
74-
- Optional downsampling using `resampling_period` (e.g., `timedelta(minutes=15)`)
71+
- Selecting specific `microgrid_id` and `component_id`.
72+
- Choosing one or more `metrics` to retrieve. Available metrics are listed [here](https://github.com/frequenz-floss/frequenz-api-common/blob/v0.8.0/proto/frequenz/api/common/v1alpha8/metrics/metrics.proto).
73+
- Defining a time range with `start_time` and `end_time`.
74+
- Optional downsampling using `resampling_period` (e.g., `timedelta(minutes=15)`).
7575

7676
```python
7777
# Asynchronously collect metric data samples into a list

0 commit comments

Comments
 (0)