Events/get_incremental_events

`get_incremental_events`token required

Streaming-style endpoint: returns events with an id strictly greater than `last_event_id`, optionally filtered.

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

Parameters

Name	Type	Required	Description
`last_event_id`	string	optional	High-water-mark event id. Defaults to '0'. Treated as a string to support 64-bit ids.e.g. `98765432`
`license_number`	string	optional	License plate filter. Alias: `license_nmbr`.e.g. `AB-123-CD`
`severity_level`	number	optional	Numeric severity threshold.e.g. `2`
`event_category_id`	string	optional	Comma-separated list of positive event category ids.e.g. `1,2,3`

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.

Name	Type	Required	Description
`page_number`	number	optional	1-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_size`	number	optional	Rows 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_incremental_events","parameters":[{"last_event_id":"98765432","license_number":"AB-123-CD","severity_level":2,"event_category_id":"1,2,3","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

env_id is taken from the session only — no parameter override. `last_event_id` defaults to `'0'` when omitted (treated as a string to support 64-bit ids). `license_nmbr` accepted as alias for `license_number`. Invalid `severity_level` or any non-positive `event_category_id` returns action_value '1'.

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_incremental_events","parameters":[{"last_event_id":"98765432","license_number":"AB-123-CD","severity_level":2,"event_category_id":"1,2,3"}]}}'

Body

{
  "action": {
    "name": "get_incremental_events",
    "parameters": [
      {
        "last_event_id": "98765432",
        "license_number": "AB-123-CD",
        "severity_level": 2,
        "event_category_id": "1,2,3"
      }
    ]
  }
}

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