List metrics with optional nesting for the parent/child hierarchy.
Returns the union of:
- Metrics scoped to the active workspace (
workspace_id == ws). - Metrics shared at the org level (
workspace_id IS NULL).
This is what makes org-shared metrics appear inside every workspace of the org without the user having to recreate them. Switching workspace in the UI still narrows the workspace-scoped half; the org-shared half is identical across workspaces.
JWT access token. Use: Authorization: Bearer .
In: header
Query Parameters
When true, include draft metrics (Studio-only) in the listing.
falseWhen true, return only draft metrics.
falseWhen true, return only metrics enabled in the active workspace. Category parents are included when at least one child is enabled.
falseWhen true (default), children are nested under their parent and not returned as top-level rows. When false, the response is a flat list of every metric (parents + standalone + orphaned children).
trueHeader Parameters
Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/metrics"[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6", "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9", "scope": "workspace", "name": "string", "description": "string", "example": "string", "metric_type": "number", "metric_category": "quality", "trigger": "always", "enabled": true, "is_default": true, "metric_origin": "string", "supported_surfaces": [ "string" ], "enabled_surfaces": [ "string" ], "custom_data_type": "string", "custom_config": {}, "tags": [ "string" ], "capture_rationale": false, "parent_metric_id": "a4a6359f-6ade-48cb-af32-ccbc80976b98", "selection_mode": "single_choice", "allow_discovery": false, "compare_transcripts": false, "lifecycle": "active", "promoted_from_draft_at": "2019-08-24T14:15:22Z", "studio_notes": "string", "children": [ {} ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "created_by": "string" }]Community & contact
- Found a bug or have a feature request? Open a GitHub issue.
- Join our Discord for faster replies!