85 lines
2.2 KiB
Markdown
85 lines
2.2 KiB
Markdown
---
|
|
name: metrics-routes
|
|
description: Handle 6 OpenAPI operation(s) under /api/metrics for the metrics route group.
|
|
---
|
|
|
|
# metrics API Routes
|
|
|
|
Handle 6 OpenAPI operation(s) under /api/metrics for the metrics route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### get_metrics
|
|
|
|
- Operation ID: `get_metrics`
|
|
- Route: `GET /api/metrics`
|
|
- Mode: READ
|
|
- Summary: Get Metrics
|
|
- Parameters:
|
|
- `fields[flow]` in `query`
|
|
- `fields[metric]` in `query`
|
|
- `filter` in `query`
|
|
- `include` in `query`
|
|
- `page[cursor]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_metric
|
|
|
|
- Operation ID: `get_metric`
|
|
- Route: `GET /api/metrics/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[flow]` in `query`
|
|
- `fields[metric]` in `query`
|
|
- `include` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_flows_triggered_by_metric
|
|
|
|
- Operation ID: `get_flows_triggered_by_metric`
|
|
- Route: `GET /api/metrics/{id}/flow-triggers`
|
|
- Mode: READ
|
|
- Summary: Get Flows Triggered by Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[flow]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_ids_for_flows_triggered_by_metric
|
|
|
|
- Operation ID: `get_ids_for_flows_triggered_by_metric`
|
|
- Route: `GET /api/metrics/{id}/relationships/flow-triggers`
|
|
- Mode: READ
|
|
- Summary: Get IDs for Flows Triggered by Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|
|
|
|
### get_properties_for_metric
|
|
|
|
- Operation ID: `get_properties_for_metric`
|
|
- Route: `GET /api/metrics/{id}/metric-properties`
|
|
- Mode: READ
|
|
- Summary: Get Properties for Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `additional-fields[metric-property]` in `query`
|
|
- `fields[metric-property]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_property_ids_for_metric
|
|
|
|
- Operation ID: `get_property_ids_for_metric`
|
|
- Route: `GET /api/metrics/{id}/relationships/metric-properties`
|
|
- Mode: READ
|
|
- Summary: Get Property IDs for Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|