Parameters/get_parameters

get_parameterstoken required

Returns the latest decoded value for each telemetry parameter type recorded for a vehicle (one row per `parameter_type`).

POST/api— body field action.name = "get_parameters"

Parameters

NameTypeRequiredDescription
vehicle_idnumberoptionalInternal vehicle id. Either `vehicle_id` or `license_nmbr` must be supplied; missing both returns action_value '1'.e.g. 591723
license_nmbrstringoptionalLicense plate. Aliases `license_number` and `License_NMBR` are also accepted. Either `vehicle_id` or `license_nmbr` must be supplied.e.g. 16699
from_datedateoptionalStart of the time-window filter (YYYY-MM-DD, UTC day boundary). Must be paired with `to_date` — supplying only one returns action_value '1'.e.g. 2026-05-25
to_datedateoptionalEnd of the time-window filter (YYYY-MM-DD, inclusive). Must be paired with `from_date` and be on or after it (action_value '1' otherwise).e.g. 2026-05-26
license_numberstringoptionalIdentify the vehicle by licence plate instead of vehicle_id. Legacy spelling License_NMBR is also accepted.e.g. 16699

Pagination

This action is paginated. The two parameters below are accepted on every call (both optional); omitting them yields page 1 with 100 rows. The response carries a pagination envelope alongside data; iterate while has_more === true.

page, page_size and has_more are present on every paginated response. total_count and total_pages are returned only by some actions — treat them as optional and drive iteration from has_more rather than from a page count worked out in advance.

NameTypeRequiredDescription
page_numbernumberoptional1-based page index. Defaults to 1 if omitted. Page 1 pins a snapshot for stateful actions (events, telemetry) — subsequent pages reuse that snapshot until the session expires (~30 minutes).e.g. 1
page_sizenumberoptionalRows per page. Defaults to 2000, which is also the maximum — larger values are silently capped to 2000, and a response of exactly 2000 rows usually means there are more pages. For stateful actions (events, telemetry) only the value sent with page 1 is honored, because later pages reuse the size pinned by the snapshot; stateless actions read it on every request.e.g. 2000
Iterate every page
curl
# Iterate every page until pagination.has_more is false.
# page_size "100" is a deliberate small page so the loop is visible — the
# default is 2000, which is also the maximum. Raise it to fetch fewer,
# larger pages; you still stop on has_more either way.
# Requires: jq (https://stedolan.github.io/jq/).
page=1
while :; do
  body=$(curl -s -X POST 'https://private.develop-1.questar.io/v2/private-questar-units/api' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_TOKEN' \
    -d '{"action":{"name":"get_parameters","parameters":[{"vehicle_id":591723,"license_nmbr":"16699","from_date":"2026-05-25","to_date":"2026-05-26","license_number":"16699","page_number":"'$page'","page_size":"100"}]}}')
  echo "$body" | jq '.response.properties.data[]'
  has_more=$(echo "$body" | jq -r '.response.properties.pagination.has_more // false')
  [ "$has_more" = "true" ] || break
  page=$((page + 1))
done

Page 1 pins a snapshot for stateful actions (events, telemetry). If the session expires (~30 min) the API returns action_value="3" with description pagination_session_expired — restart from page_number=1.

Notes

action_value codes: '0' success, '1' invalid input parameters (missing identity, mismatched/invalid dates), '2' vehicle not found or not allowed for this user, '999' missing session / general error. Returns at most one row per `parameter_type` (stateless DISTINCT-ON pagination). `last_input_value` is unit-converted per the client's measuring method (Metric / Imperial / Imperial_UsGal) and formatted to 7 decimal places. `parameter_type_description` and `last_input_time` are URL-encoded on the wire.

Request

curl
curl -X POST 'https://private.develop-1.questar.io/v2/private-questar-units/api' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  --data '{"action":{"name":"get_parameters","parameters":[{"vehicle_id":591723,"license_nmbr":"16699","from_date":"2026-05-25","to_date":"2026-05-26","license_number":"16699"}]}}'
Body
{
  "action": {
    "name": "get_parameters",
    "parameters": [
      {
        "vehicle_id": 591723,
        "license_nmbr": "16699",
        "from_date": "2026-05-25",
        "to_date": "2026-05-26",
        "license_number": "16699"
      }
    ]
  }
}

Response

Successful responses always wrap the action's payload in response.properties. The action_value field reports the handler outcome: "0" for success, "1" for invalid params, "2" for not allowed, "3" for limit-exceeded /pagination-session-expired, "999" for general error.

200 OK
{
  "response": {
    "properties": {
      "action_name": "get_parameters",
      "action_value": "0",
      "description": "success",
      "data": [
        {
          "vehicle_id": "591723",
          "license_number": "17108",
          "parameter_type": "10000",
          "parameter_type_description": "Sys%20Param%20Ignition",
          "last_input_value": "0.0000000",
          "last_input_time": "2026-05-25T16%3A28%3A11"
        }
      ],
      "pagination": {
        "page": 1,
        "page_size": 100,
        "total_count": 532,
        "total_pages": 6,
        "has_more": true
      }
    }
  }
}