List project measurement summary row rows
Projects module
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.
- 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
| 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 ProjectMeasurementSummary
| Field | Type | Required | Description |
|---|---|---|---|
| project_id | string (uuid) | Yes | Identifier of the project. |
| metric_code | string | Yes | Metric (app.measurement_metrics).Constraints: pattern ^[a-z][a-z0-9_]*$ |
| family | "Sustainability" | "Audience" | "Earned Media" | "Sentiment" | Yes | Family of the figure. |
| dimension | "Mass" | "Volume" | "Energy" | "Emissions" | "Count" | "Percent" | Yes | Dimension of the figure. |
| base_unit_code | string | Yes | Unit of target_base and measured_base.Constraints: pattern ^[a-z][a-z0-9_]*$ |
| aggregation | "Sum" | "Latest" | Yes | How figures combine. |
| objective_id | string (uuid) | null | Yes | Identifier of the live gate 1 objective for the metric. |
| direction | "At Least" | "At Most" | null | Yes | Direction of the objective. |
| target_value | number | null | Yes | Target as set, in target_unit_code. |
| target_unit_code | string | null | Yes | Unit the target was set in.Constraints: pattern ^[a-z][a-z0-9_]*$ |
| target_base | number | null | Yes | Target in the base unit. |
| measured_count | integer | Yes | Figures with a value.Constraints: range 0 to any |
| unmeasured_count | integer | Yes | Figures recorded as not measured; never counted as zero.Constraints: range 0 to any |
| measured_base | number | null | Yes | Total (Sum) or latest figure (Latest) in the base unit; null when nothing was measured. |
| last_measured_on | string (date) | null | Yes | Day of the most recent measured figure. |
| outcome | "Met" | "Not Met" | "Incomplete" | "Unmeasured" | null | Yes | 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
}Code samples
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