List project measurement summary row rows

Módulo Projects

GET/project-measurement-summaryprojectMeasurementSummary.list

Gate 8 measurement against the gate 1 objectives, per project and metric, in the metric's base unit. Totals cover measured figures only, with the unmeasured count beside them; with nothing measured the figure is null (Unmeasured), never zero. Returns a cursor page of project measurement summary row rows the caller may see. The default order is `project_id`, then `metric_code` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad projects.gate.read.
Alcances de OAuth: projects.
Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

projectMeasurementSummary.list: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
limit	Limit	No	Page size. Default 50, maximum 200.Restricciones: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: 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).Restricciones: 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.

Respuesta 200: una página de ProjectMeasurementSummary

projectMeasurementSummary.list: ProjectMeasurementSummary
Campo	Tipo	Obligatorio	Descripción
project_id	string (uuid)	Sí	Identifier of the project.
metric_code	string	Sí	Metric (app.measurement_metrics).Restricciones: pattern ^[a-z][a-z0-9_]*$
family	"Sustainability" \| "Audience" \| "Earned Media" \| "Sentiment"	Sí	Family of the figure.
dimension	"Mass" \| "Volume" \| "Energy" \| "Emissions" \| "Count" \| "Percent"	Sí	Dimension of the figure.
base_unit_code	string	Sí	Unit of target_base and measured_base.Restricciones: pattern ^[a-z][a-z0-9_]*$
aggregation	"Sum" \| "Latest"	Sí	How figures combine.
objective_id	string (uuid) \| null	Sí	Identifier of the live gate 1 objective for the metric.
direction	"At Least" \| "At Most" \| null	Sí	Direction of the objective.
target_value	number \| null	Sí	Target as set, in target_unit_code.
target_unit_code	string \| null	Sí	Unit the target was set in.Restricciones: pattern ^[a-z][a-z0-9_]*$
target_base	number \| null	Sí	Target in the base unit.
measured_count	integer	Sí	Figures with a value.Restricciones: range 0 to any
unmeasured_count	integer	Sí	Figures recorded as not measured; never counted as zero.Restricciones: range 0 to any
measured_base	number \| null	Sí	Total (Sum) or latest figure (Latest) in the base unit; null when nothing was measured.
last_measured_on	string (date) \| null	Sí	Day of the most recent measured figure.
outcome	"Met" \| "Not Met" \| "Incomplete" \| "Unmeasured" \| null	Sí	Met, Not Met, Incomplete (unmeasured figures leave the objective undecided) or Unmeasured; null without an objective.

{
  "data": [
    {
      "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "metric_code": "waste_generated",
      "family": "Sustainability",
      "dimension": "Mass",
      "base_unit_code": "kg",
      "aggregation": "Sum",
      "objective_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "direction": "At Most",
      "target_value": 2,
      "target_unit_code": "kg",
      "target_base": 2000,
      "measured_count": 2,
      "unmeasured_count": 1,
      "measured_base": 1953.59237,
      "last_measured_on": "2026-10-08",
      "outcome": "Met"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/project-measurement-summary" \
  -H "Authorization: Bearer $XOS_API_KEY"

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

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

xos project-measurement-summary list --all