List measurement metric tag rows

Projects module

GET/measurement-metric-tagsmeasurementMetricTags.list

A Bible sustainability tag (Bible tab 09) a sustainability figure is reported against (Section 4.10). Returns a cursor page of measurement metric tag rows the caller may see. The default order is `metric_code`, then `tag_id` ascending. Supports sparse fieldsets and the filter grammar.

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

Path and query parameters

measurementMetricTags.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 MeasurementMetricTag

measurementMetricTags.list: MeasurementMetricTag
Field	Type	Required	Description
metric_code	string	Yes	Metric (app.measurement_metrics).Constraints: pattern ^[a-z][a-z0-9_]*$
tag_id	string	Yes	Canon tag code.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
tag	string	Yes	Tag value as written in canon.Constraints: length 1 to 200

{
  "data": [
    {
      "metric_code": "waste_generated",
      "tag_id": "TAG-005",
      "tag": "REUSABLE"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/measurement-metric-tags" \
  -H "Authorization: Bearer $XOS_API_KEY"

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

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

xos measurement-metric-tags list --all