Get a canon metric
Canon module
GET/canon/metrics/{item}canonMetrics.get
A metric, often code-derived and jurisdiction-bound. Returns one canon metric with its `ETag`. A canon metric the caller may not see returns 404.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| item | string | Yes | Metric item.Constraints: length 1 to 200 |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: CanonMetric
| Field | Type | Required | Description |
|---|---|---|---|
| domain | string | Yes | Metric domain.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| item | string | Yes | Metric item.Constraints: length 1 to 200 |
| value_numeric | number | null | Yes | Metric value. |
| qualifier | string | null | Yes | Qualifier of the value: the code section or modelling note it follows.Constraints: length 1 to 1000 |
| source | string | null | Yes | Source of the value.Constraints: length 1 to 300 |
| is_code_derived | boolean | Yes | Whether the value comes from a code. |
| jurisdiction_id | JurisdictionId | Yes | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$ |
| is_jurisdiction_neutral | boolean | Yes | Whether the value holds in every jurisdiction. |
| provenance | Provenance | Yes | Provenance from `xpms.dim_provenance` (Section 3.8); a lower rank never overwrites a higher one.Constraints: pattern ^[a-z]+$ |
| value_text | string | null | Yes | Value as text, when canon states it in words.Constraints: length 1 to 300 |
{
"domain": "capacity",
"item": "Stage or performance area",
"value_numeric": 15,
"qualifier": "IBC 1005.3.2 - 0.2 in per occupant",
"source": "IBC 1004.5",
"is_code_derived": true,
"jurisdiction_id": "US-FL",
"is_jurisdiction_neutral": false,
"provenance": "operator",
"value_text": "Per show day"
}Code samples
curl -X GET "$XOS_BASE_URL/canon/metrics/Stage%20or%20performance%20area" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonMetrics.get("Stage or performance area");response = xos.canon_metrics.get("Stage or performance area")xos canon-metrics get Stage or performance area