Skip to main content
Get detailed information for a cell measurement

Path Parameters

measurement_id
string
required

Query Parameters

target_rows
integer | null

Target rows for downsampled time series

Required range: x >= 1
columns
string | null

Comma-separated list of columns to load (e.g., 'time,voltage')

step_counts
string | null

Comma-separated list of step counts to filter (e.g., '0,1,2')

cycle_counts
string | null

Comma-separated list of cycle counts to filter (e.g., '1,2,3')

time_min
number | null

Deprecated: use x_min with x_column instead.

time_max
number | null

Deprecated: use x_max with x_column instead.

x_min
number | null

Minimum x-axis value to filter

x_max
number | null

Maximum x-axis value to filter

x_column
string | null

Column name for x-axis filtering (e.g., 'Time [s]' or 'Capacity throughput [A.h]')

include_steps
boolean
default:true

Include steps in response.

include_time_series
boolean
default:true

Include time_series in response.

Response

Successful Response

Response model for the /detail endpoint for a single measurement.

name
string
required
Required string length: 1 - 255
id
string
required
cell_instance_id
string
required
organization_id
string
required

Organization this measurement belongs to.

created_at
string<date-time>
required
updated_at
string<date-time>
required
specification
CellSpecification · object
required

Model representing a cell specification as returned by the API.

instance
CellInstance · object
required

Model representing a cell instance as returned by the API.

protocol
Protocol · object | null

Protocol information. Typical keys: 'name' (str), 'ambient_temperature_degc' (float), 'definition' (dict | str — a UCP protocol definition or another protocol format).

start_time
string<date-time> | null

ISO 8601 datetime with timezone (UTC preferred) marking when the test started.

end_time
string<date-time> | null

ISO 8601 datetime with timezone (UTC preferred) marking when the test finished. Leave null while the test is still running; set it once the measurement is complete. A null end_time means the cell is still considered 'on test' in the Lab view.

test_setup
Test Setup · object | null

Physical test setup. Typical keys: 'cycler' (model), 'operator', 'lab', 'channel_number' (int).

step_labels_validated
boolean
default:false

Set to true only once step-type labels (Rest, CC charge, CV, discharge, etc.) have been manually reviewed. Server-inferred labels should leave this false.

notes
string | null

Free-text notes about the cell measurement

measurement_type
enum<string>
default:time_series

What shape of data this measurement holds. Determines which fields are populated and which upload flow applies. See the class docstring.

Available options:
time_series,
file,
properties
properties
Properties · object | null

Flat key/value measurements, populated only when measurement_type is 'properties'. Numeric values use the Quantity format. Example: {'thickness': {'value': 0.52, 'unit': 'mm'}, 'DCIR': {'value': 12, 'unit': 'mohm'}}.

file_metadata
File Metadata · object | null

Metadata about uploaded files (MIME types, dimensions, etc.)

channel_id
string | null

Optional ID of the channel this measurement ran on.

project_id
string | null

Project this measurement belongs to

created_by
string | null

User ID of the user who created this measurement

created_by_email
string | null

Email of the user who created this measurement

steps
Steps · object | null
time_series
Time Series · object | null
cycles
Cycles · object | null