Events/get_events

get_eventstoken required

Returns vehicle events filtered by category, severity, license/vehicle/chassis and last_time.

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

Parameters

NameTypeRequiredDescription
event_category_idstringoptionalComma-separated list of event category ids (each parsed as int).e.g. 1,2,3
severity_levelnumberoptionalNumeric severity threshold.e.g. 2
license_numberstringoptionalLicense plate filter.e.g. 17108
vehicle_idnumberoptionalInternal vehicle id.e.g. 591723
chassis_numberstringoptionalVIN / chassis serial filter.e.g. 1HGCM82633A004352
last_timedateoptionalOnly return events after this timestamp.e.g. 2026-05-26T00:00:00Z
event_idnumberoptionalReturn a single event by id. Bypasses the time window entirely.e.g. 2173309686

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.stage.questar.io/v2/private-questar-units/api' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_TOKEN' \
    -d '{"action":{"name":"get_events","parameters":[{"event_category_id":"1,2,3","severity_level":2,"license_number":"17108","vehicle_id":591723,"chassis_number":"1HGCM82633A004352","last_time":"2026-05-26T00:00:00Z","event_id":2173309686,"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

Requires a valid session token. String fields are url-encoded for legacy compatibility.

Request

curl
curl -X POST 'https://private.stage.questar.io/v2/private-questar-units/api' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  --data '{"action":{"name":"get_events","parameters":[{"event_category_id":"1,2,3","severity_level":2,"license_number":"17108","vehicle_id":591723,"chassis_number":"1HGCM82633A004352","last_time":"2026-05-26T00:00:00Z","event_id":2173309686}]}}'
Body
{
  "action": {
    "name": "get_events",
    "parameters": [
      {
        "event_category_id": "1,2,3",
        "severity_level": 2,
        "license_number": "17108",
        "vehicle_id": 591723,
        "chassis_number": "1HGCM82633A004352",
        "last_time": "2026-05-26T00:00:00Z",
        "event_id": 2173309686
      }
    ]
  }
}

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_events",
      "action_value": "0",
      "description": "success",
      "data": [
        {
          "event_id": "98765432",
          "event_type_id": "12",
          "event_type_description": "Harsh%20Braking",
          "event_category": "3",
          "event_category_description": "Driving%20Behavior",
          "vehicle_id": "555",
          "license_number": "AB-123-CD",
          "chassis_number": "1HGCM82633A004352",
          "drive_id": "44321",
          "time": "2026-04-27T08%3A05%3A12Z",
          "driver_id": "789",
          "driver_name": "John%20Doe",
          "worker_id": "W-789",
          "driver_number": "DRV-789",
          "longitude": "34.8000000",
          "latitude": "32.0901000",
          "direction": "182",
          "speed": "55",
          "mileage": "152305.10",
          "client_id": "42",
          "client_name": "Acme%20Logistics"
        }
      ],
      "pagination": {
        "page": 1,
        "page_size": 100,
        "has_more": true
      }
    }
  }
}