List all available engineering metric definitions.
USAGE - Call this endpoint BEFORE querying metrics (queryPointInTimeMetrics):
1. Once at start: Call with view='basic' to discover all available metrics - cache this response
2. Once per metric: Call with view='full' and key=METRIC_KEY to get detailed metadata - cache each response
3. Use cached metadata to construct valid point-in-time queries
Cache responses in your context. Only refresh if no longer in your context window or explicitly requested (ex to check if metric readiness has changed).
Query parameters:
- view: 'basic' (default) returns minimal info, 'full' includes sources and query metadata
- key: Filter metrics by key (supports multiple values and comma-separated lists)
Full view provides query construction metadata:
- supportedAggregations: Valid aggregation methods for the metric
- orderByAttribute: Attribute path for sorting by metric values
- groupByOptions[].key: Valid groupBy keys (use exact values, do NOT guess)
- filterOptions[].key: Valid filter keys (use exact values, do NOT guess)
Valid orderBy attributes for metric queries:
- orderByAttribute: The metric value itself (returned in full view)
- Source attributes: Any attribute from the metric's source (e.g., "source_name.attribute_name")
- Dimension attributes: Any attribute from related dimensions (e.g., "source_name.dimension_name.attribute_name")
Filter operators by type (for constructing queries):
- STRING: EQUAL, NOT_EQUAL, IS_NULL, IS_NOT_NULL, LIKE, NOT_LIKE, IN, NOT_IN, ANY
- INTEGER/DECIMAL/DOUBLE: EQUAL, NOT_EQUAL, IS_NULL, IS_NOT_NULL, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, IN, NOT_IN, BETWEEN, ANY
- DATETIME/DATE: EQUAL, NOT_EQUAL, IS_NULL, IS_NOT_NULL, GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, BETWEEN
- BOOLEAN: EQUAL, NOT_EQUAL, IS_NULL, IS_NOT_NULL, IN, NOT_IN
- ARRAY: EQUAL, CONTAINS, IN
Error responses:
- 400: Invalid view parameter (must be 'basic' or 'full')
- 403: Restricted Feature (contact help@cortex.io)