2.5 KiB
2.5 KiB
name, description
| name | description |
|---|---|
| custom-metrics-routes | 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]inqueryfields[metric]inqueryincludeinqueryrevisioninheaderrequired
create_custom_metric
- Operation ID:
create_custom_metric - Route:
POST /api/custom-metrics - Mode: WRITE
- Summary: Create Custom Metric
- Parameters:
fields[custom-metric]inqueryrevisioninheaderrequired
- 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:
idinpathrequiredfields[custom-metric]inqueryfields[metric]inqueryincludeinqueryrevisioninheaderrequired
update_custom_metric
- Operation ID:
update_custom_metric - Route:
PATCH /api/custom-metrics/{id} - Mode: WRITE
- Summary: Update Custom Metric
- Parameters:
idinpathrequiredfields[custom-metric]inqueryrevisioninheaderrequired
- 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:
idinpathrequiredrevisioninheaderrequired
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:
idinpathrequiredfields[metric]inqueryrevisioninheaderrequired
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:
idinpathrequiredrevisioninheaderrequired