List canon metric rows

Canon module

GET/canon/metricscanonMetrics.list

A metric, often code-derived and jurisdiction-bound. Returns a cursor page of canon metric rows the caller may see. The default order is `item` ascending. Supports sparse fieldsets and the filter grammar.

Requires the capability canon.taxonomy.read.
OAuth scopes: canon.
Cursor-paginated: limit, cursor, fields, sort and filter apply.
Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

canonMetrics.list: Path and query parameters
Field	Type	Required	Description
limit	Limit	No	Page size. Default 50, maximum 200.Constraints: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
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_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Response 200: a page of CanonMetric

canonMetrics.list: 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

{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/canon/metrics" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.canonMetrics.listAll()) {
  console.log(row);
}

for row in xos.canon_metrics.list_all():
    print(row)

xos canon-metrics list --all