List project measurement rows

Módulo Projects

GET/project-measurementsprojectMeasurements.list

A figure measured on a project (Section 4.10) for one metric, day and source. A null value records that the figure was not measured (Unmeasured), never zero. Correcting the value, unit or day needs correction_reason and writes the change to the correction ledger. Who recorded it and when are created_by and created_at. Returns a cursor page of project measurement rows the caller may see. The default order is `created_at` 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

projectMeasurements.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 ProjectMeasurement

projectMeasurements.list: ProjectMeasurement
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the project measurement.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row.
project_id	string (uuid)	Sí	Identifier of the project.
metric_code	string	Sí	Metric (app.measurement_metrics).Restricciones: pattern ^[a-z][a-z0-9_]*$
measured_on	string (date)	Sí	Day the figure covers, on the project's calendar; today there when omitted, never later.
value	number \| null	Sí	The figure in unit_code; null when not measured.
unit_code	string \| null	Sí	Unit of the figure, of the metric's dimension.Restricciones: pattern ^[a-z][a-z0-9_]*$
source	"Manual" \| "Import" \| "Integration"	Sí	How the figure reached XOS.
source_reference	string \| null	Sí	What the figure came from, such as an invoice, a meter reading or a file name.Restricciones: length 1 to 300
source_uri	string \| null	Sí	Link to the source: an http(s) URL or a URN.Restricciones: length 1 to 2000
note	string \| null	Sí	Note.Restricciones: length 1 to 2000

{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "created_at": "2026-10-08T14:30:00Z",
      "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "updated_at": "2026-10-08T14:30:00Z",
      "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "metric_code": "waste_generated",
      "measured_on": "2026-10-08",
      "value": 1200,
      "unit_code": "kg",
      "source": "Import",
      "source_reference": "Hauler invoice 4471",
      "source_uri": "https://hauler.example/invoices/4471",
      "note": "Two roll-off containers."
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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

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

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

xos project-measurements list --all