Metrics pillar · v0.7.1
metric MetricDefinition
Metric definition with formula, source, and standards mapping.
$id · https://corpospec.com/schemas/v0.7.1/metric.schema.json
Fields
| Field | Type | Required | Description |
|---|---|---|---|
| description | string | yes | |
| direction | MetricDirection | yes | Metric direction. |
| frequency | MetricFrequency | yes | Metric frequency. |
| id | PathRef | yes | Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$` |
| name | string | yes | |
| unit | MetricUnit | yes | Metric unit type. |
| abbreviation | string? | — | |
| formula | string? | — | |
| iso_30414_mapping | string? | — | |
| related_metrics | PathRef[] | — | |
| source | MetricSource? | — | |
| tags | string[] | — | |
| xbrl_mapping | string? | — |
Definitions
Shared types referenced within this schema.
MetricDirection
Metric direction.
enum: "up", "down", "neutral"
MetricFrequency
Metric frequency.
enum: "daily", "weekly", "monthly", "quarterly", "annually"
MetricSource
Metric data source.
type: object
MetricUnit
Metric unit type.
enum: "currency", "count", "ratio", "percentage", "days", "months", "hours", "weight", "volume", "area", "score", "nps", "units", "bps"
PathRef
Path-based cross-reference relative to .corpospec/ root.
Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
pattern: ^[a-z0-9_-]+(/[a-z0-9_.-]+)+$
Reference in your YAML
# yaml-language-server: $schema=https://corpospec.com/schemas/v0.7.1/metric.schema.json