Guides
Getting startedVisit een.comMy Application/Login

Events and Analytics

Vehicle Surveillance, License Plate Recognition, and Point of Sale Events

Suggest Edits

lpr - Manage License Plate Recognition (LPR) Events

NAME

lpr - manage and retrieve License Plate Recognition events.

SYNOPSIS

een lpr events [OPTIONS]

DESCRIPTION

The lpr events command allows you to retrieve LPR events within a specified time frame. It supports filtering by license plate number and camera ESN.

COMMANDS

events

Get LPR events.

Required options:

  • --start-time [start time]
    Events start time.
  • --end-time [end time]
    Events end time.

Optional options:

  • --lp [license plate]
    License plate number.

  • --esn [esn]
    The ESN for camera of interest.

  • --debug
    Enable detailed debug output for troubleshooting.

  • --v1
    Use v1 APIs.

Notes:

  • start-time and end-time time format should be YYYYMMDDHHMMSS.sss (Compact ISO 8601 date time with millisecond precision)

Actions:

  • If --v1 is specified along with both --start-time and --end-time, it retrieves LPR events using v1 APIs.
  • If only the start and end times are specified, it retrieves LPR events using the default API.

EXAMPLES

  • To get LPR events for a specific time frame:
een lpr events --start-time "20241001000000.000" --end-time "20241001010000.000"
  • To get LPR events for a specific license plate:
een lpr events --start-time "20241001000000.000" --end-time "20241001010000.000" --lp "ABC123"

vsp - Manage Vehicle Surveillance Package (VSP) Events and Alerts

NAME

vsp - manage and retrieve Vehicle Surveillance Processing events and alerts.

SYNOPSIS

een vsp [COMMAND] [OPTIONS]

DESCRIPTION

The vsp command allows you to manage and retrieve VSP events and alerts based on parameters such as time, vehicle characteristics, and alert types.

COMMANDS

listevents

Get VSP events.

Options:

  • --start-time [start time]
    LPR start time.
  • --end-time [end time]
    LPR end time.
  • --lp [lp]
    License plate number.
  • --esns [esns]
    Camera ESNs.
  • --makes [makes]
    Vehicle makes.
  • --sites [sites]
    Site names.
  • --colors [colors]
    Vehicle colors.
  • --body-types [types]
    Vehicle body types.
  • --directions [directions]
    Direction of the vehicle.
  • --access-type [access type]
    Access type.
  • --html
    Generate chart in HTML file.
  • -f, --file-name [file name]
    Specify the name of the file where the output will be saved.
  • --no-prompt
    Skip all user confirmation prompts.
  • --debug
    Enable detailed debug output for troubleshooting.

Notes:

  • If you haven't specified any start-time and end-time it will take last 24 hours as default timestamps.
  • start-time and end-time time format should be YYYYMMDDHHMMSS.sss (Compact ISO 8601 date time with millisecond precision).

Actions:

  • If --html is specified, it generates a report of VSP events.
  • If not, it retrieves VSP events and saves them according to the specified options.

listalerts

Get VSP alerts.

Options

  • --start-time [start time]
    LPR start time.

  • --end-time [end time]
    LPR end time.

  • --esns [esns]
    Camera ESN.

  • --sites [sites]
    Name of the site.

  • --allowed-vehicle
    Alert type - allowed vehicle.

  • --denied-vehicle
    Alert type - denied vehicle.

  • --count-of-license-plate
    Alert type - count of license plate.

  • --hotlist
    Alert type - hotlist.

  • --unregistered-vehicle
    Alert type - unregistered vehicle.

  • --watch-vehicle
    Alert type - watch vehicle.

  • --html
    Generate chart in HTML file.

  • -f, --file-name [file name]
    Specify the name of the file where the output will be saved.

  • --no-prompt
    Skip all user confirmation prompts.

  • --debug
    Enable detailed debug output for troubleshooting.

Notes:

  • If you haven't specified any start-time and end-time it will take last 24 hours as default timestamps.
  • start-time and end-time time format should be YYYY-MM-DDTHH:MM:SS.sss±HH:MM (ISO 8601 extended date-time).

Actions:

  • If --html is specified, it generates a report of VSP alerts.
  • If not, it retrieves VSP alerts and saves them according to the specified options.

EXAMPLES

  • To get VSP events for a specific time frame:
een vsp listevents --start-time "20241001000000.000" --end-time "20241001235959.000"
  • To get VSP alerts for allowed vehicles:
een vsp listalerts --start-time 2024-11-17T09:20:54.619+00:00 --end-time 2024-11-18T09:20:54.619+00:00 --allowed-vehicle

pos - Manage Point of Sale (POS) Events

NAME

pos - manage and retrieve Point of Sale events.

SYNOPSIS

een pos listevents [OPTIONS]

DESCRIPTION

The pos command allows you to manage and retrieve POS events based on parameters such as time, transaction details, and site.

COMMANDS

listevents

Get POS events.

Options

  • --start-time [start time]
    Defines the starting point for retrieving events. The timestamp must be in ISO 8601 format with millisecond precision (e.g., YYYY-MM-DDTHH:MM:SS.sss±HH:MM).

  • --end-time [end time]
    Defines the end point for retrieving events. The timestamp must be in ISO 8601 format with millisecond precision (e.g., YYYY-MM-DDTHH:MM:SS.sss±HH:MM).

  • --sites [sites]
    Specify the name of the site.

  • --transaction-type [transaction type]
    Specify the type of the transaction.

  • --net-amount-min [net amount min]
    Specify the minimum net amount.

  • --net-amount-max [net amount max]
    Specify the maximum net amount.

  • --employee-id [employee ID]
    Specify the ID of the employee.

  • --discount-min [discount min]
    Specify the minimum discount in percentage.

  • --discount-max [discount max]
    Specify the maximum discount in percentage.

  • --bill-number [bill number]
    Specify the bill number.

  • --flagged
    Retrieve flagged transactions.

  • --html
    Generate chart in HTML file.

  • -f, --file-name [file name]
    Specify the name of the file where the output will be saved.

  • --no-prompt
    Skip all user confirmation prompts.

  • --debug
    Enable detailed debug output for troubleshooting.

Notes:

  • If no start time or end time is specified, the retrieval period defaults to the last 24 hours.
  • Start-time and end-time time format should be YYYY-MM-DDTHH:MM:SS.sss±HH:MM (ISO 8601 extended date-time).

Actions:

  • If --html is specified, it generates a report of POS events.
  • If not, it retrieves POS events and saves them according to the specified options.

EXAMPLES

  • To get POS events for a specific time frame:
een pos listevents --start-time 2024-11-17T09:20:54.619+00:00 --end-time 2024-11-18T09:20:54.619+00:00
  • To get flagged POS transactions:
een pos listevents --flagged

Updated about 22 hours ago

What’s Next