Get detailed information for a cell measurement

Retrieves detailed information for a specific cell measurement by measurement ID.

Deprecated: prefer the individual endpoints GET /steps, GET /cycles, GET /time_series, and GET /steps_and_cycles instead.

Supports zoom-based resampling: specify x_min, x_max, and x_column to fetch higher resolution data for a specific x-axis range.

Get detailed information for a cell measurement

cURL

curl --request GET \
  --url https://api.ionworks.com/cell_measurements/{measurement_id}/detail

import requests

url = "https://api.ionworks.com/cell_measurements/{measurement_id}/detail"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.ionworks.com/cell_measurements/{measurement_id}/detail', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ionworks.com/cell_measurements/{measurement_id}/detail",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ionworks.com/cell_measurements/{measurement_id}/detail"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.ionworks.com/cell_measurements/{measurement_id}/detail")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ionworks.com/cell_measurements/{measurement_id}/detail")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "name": "<string>",
  "id": "<string>",
  "cell_instance_id": "<string>",
  "organization_id": "<string>",
  "project_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "specification": {
    "name": "<string>",
    "ratings": {
      "capacity": {
        "value": 123,
        "unit": "<string>"
      },
      "voltage_min": {
        "value": 123,
        "unit": "<string>"
      },
      "voltage_max": {
        "value": 123,
        "unit": "<string>"
      },
      "nominal_voltage": {
        "value": 123,
        "unit": "<string>"
      },
      "energy": {
        "value": 123,
        "unit": "<string>"
      },
      "energy_density_gravimetric": {
        "value": 123,
        "unit": "<string>"
      },
      "energy_density_volumetric": {
        "value": 123,
        "unit": "<string>"
      },
      "max_discharge_rate": {
        "value": 123,
        "unit": "<string>"
      },
      "max_charge_rate": {
        "value": 123,
        "unit": "<string>"
      }
    },
    "id": "<string>",
    "organization_id": "<string>",
    "project_id": "<string>",
    "form_factor": "<string>",
    "manufacturer": "<string>",
    "anode_id": "<string>",
    "cathode_id": "<string>",
    "electrolyte_id": "<string>",
    "separator_id": "<string>",
    "case_id": "<string>",
    "properties": {},
    "source": {},
    "notes": "<string>",
    "created_by": "<string>",
    "created_by_email": "<string>",
    "instance_ids": [
      {}
    ],
    "default_parameterized_model_id": "<string>"
  },
  "instance": {
    "name": "<string>",
    "id": "<string>",
    "cell_specification_id": "<string>",
    "organization_id": "<string>",
    "project_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "batch": "<string>",
    "date_manufactured": "2023-11-07T05:31:56Z",
    "measured_properties": {},
    "notes": "<string>",
    "created_by": "<string>",
    "created_by_email": "<string>",
    "measurement_ids": [
      {}
    ]
  },
  "protocol": {},
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "estimated_end_time": "2023-11-07T05:31:56Z",
  "estimated_end_time_note": "<string>",
  "estimated_end_time_calculated_at": "2023-11-07T05:31:56Z",
  "test_setup": {},
  "step_labels_validated": false,
  "notes": "<string>",
  "measurement_type": "time_series",
  "properties": {},
  "file_metadata": {},
  "channel_id": "<string>",
  "program_id": "<string>",
  "created_by": "<string>",
  "created_by_email": "<string>",
  "steps": {},
  "time_series": {},
  "cycles": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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

200

application/json

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.

project_id · string · required

Project 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.

Show child attributes

instance · CellInstance · object · required

Model representing a cell instance as returned by the API.

Show child attributes

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.

estimated_end_time · string<date-time> | null

ISO 8601 datetime with timezone (UTC preferred) forecasting when a still-running test will finish. Distinct from end_time (the actual finish): this is an estimate. Null when no estimate has been computed yet.

estimated_end_time_note · string | null

Free-text explanation of how estimated_end_time was derived.

estimated_end_time_calculated_at · string<date-time> | null

ISO 8601 datetime with timezone marking when estimated_end_time was last computed.

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.

program_id · string | null

Optional catalog program for this measurement (copied from a linked planned measurement when present).

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

Show child attributes

time_series · Time Series · object | null

Show child attributes

cycles · Cycles · object | null

Show child attributes