Filter steps by SQL condition (paginated)

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

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

Filter steps by SQL condition (paginated)

Filter measurement steps by a SQL WHERE condition and return step counts. Returns one page of matching step counts. Use limit <= 1000 and repeat with increasing offset until fewer than limit rows are returned to fetch all matches. This endpoint allows filtering steps using SQL syntax and returns the step counts from matching steps. Useful for finding specific steps with certain characteristics (e.g., "find all 1-hour discharge steps"). Match modes: - "step" (default): Return only steps that match the condition - "cycle": Return ALL steps from cycles that have at least one step matching the condition (useful for getting complete cycles) Available columns for filtering: - duration_s: Step duration in seconds - cycle_count, step_count: Cycle and step numbers - charge_capacity_ah, discharge_capacity_ah: Capacities - charge_energy_wh, discharge_energy_wh: Energies - min_voltage_v, max_voltage_v, mean_voltage_v: Voltage stats - min_current_a, max_current_a, mean_current_a: Current stats - And more (see MeasurementStepBase schema) Example queries: - duration_s >= 3600 (steps lasting 1+ hour) - charge_capacity_ah > 1.5 - duration_s BETWEEN 1800 AND 7200

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

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

Path Parameters

measurement_id

string

required

Query Parameters

where_clause

string

required

SQL WHERE clause to filter steps. Example: duration_s >= 3600

match_mode

string

default:step

How to match steps. 'step' returns only steps matching the condition. 'cycle' returns ALL steps from cycles that have at least one step matching the condition.

limit

integer

default:1000

Number of step counts to return per page (max 1000).

Required range: 1 <= x <= 1000

offset

integer

default:0

Number of step counts to skip for pagination.

Required range: x >= 0

Response

Successful Response

⌘I