94 lines
2.5 KiB
Markdown
94 lines
2.5 KiB
Markdown
---
|
|
name: custom-metrics-routes
|
|
description: Handle 7 OpenAPI operation(s) under /api/custom-metrics for the custom metrics route group.
|
|
---
|
|
|
|
# custom metrics API Routes
|
|
|
|
Handle 7 OpenAPI operation(s) under /api/custom-metrics for the custom 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_custom_metrics
|
|
|
|
- Operation ID: `get_custom_metrics`
|
|
- Route: `GET /api/custom-metrics`
|
|
- Mode: READ
|
|
- Summary: Get Custom Metrics
|
|
- Parameters:
|
|
- `fields[custom-metric]` in `query`
|
|
- `fields[metric]` in `query`
|
|
- `include` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### create_custom_metric
|
|
|
|
- Operation ID: `create_custom_metric`
|
|
- Route: `POST /api/custom-metrics`
|
|
- Mode: WRITE
|
|
- Summary: Create Custom Metric
|
|
- Parameters:
|
|
- `fields[custom-metric]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_custom_metric
|
|
|
|
- Operation ID: `get_custom_metric`
|
|
- Route: `GET /api/custom-metrics/{id}`
|
|
- Mode: READ
|
|
- Summary: Get Custom Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[custom-metric]` in `query`
|
|
- `fields[metric]` in `query`
|
|
- `include` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### update_custom_metric
|
|
|
|
- Operation ID: `update_custom_metric`
|
|
- Route: `PATCH /api/custom-metrics/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Update Custom Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[custom-metric]` in `query`
|
|
- `revision` in `header` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_custom_metric
|
|
|
|
- Operation ID: `delete_custom_metric`
|
|
- Route: `DELETE /api/custom-metrics/{id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete Custom Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|
|
|
|
### get_metrics_for_custom_metric
|
|
|
|
- Operation ID: `get_metrics_for_custom_metric`
|
|
- Route: `GET /api/custom-metrics/{id}/metrics`
|
|
- Mode: READ
|
|
- Summary: Get Metrics for Custom Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `fields[metric]` in `query`
|
|
- `revision` in `header` required
|
|
|
|
### get_metric_ids_for_custom_metric
|
|
|
|
- Operation ID: `get_metric_ids_for_custom_metric`
|
|
- Route: `GET /api/custom-metrics/{id}/relationships/metrics`
|
|
- Mode: READ
|
|
- Summary: Get Metric IDs for Custom Metric
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
- `revision` in `header` required
|