# Retrieve Information About Terminal Dwell Statistics

This API endpoint provides information about container dwell time in a specific terminal. The dwelling time is calculated as an average dwell within the specified date range.
Dwell time is average time spent in hours on the terminal between containers discharge date and gate out date or from discharge to current dwell time on terminal.

Endpoint: GET /terminalmetrics/v{version}/terminals/{terminal_id}/containerdwelltime
Version: v1
Security: apikey

## Path parameters:

  - `terminal_id` (string, required)
    terminal GUID(terminal_id) retrieved from the terminal API call

  - `version` (string, required)

## Query parameters:

  - `start_date` (string, required)
    Include all containers discharged after this date/time in dwell aggregation(Format: yyyy-MM-ddTHH:mm:ss)

  - `end_date` (string, required)
    Include all containers discharged prior to this date/time in dwell aggregation(Format: yyyy-MM-ddTHH:mm:ss)

  - `dwell_option` (string, required)
    - on_terminal_only:
  Retrieve dwell statistics only for containers which are on terminal.
- off_terminal_only:
  Retrieve dwell statistics only for containers that have already left the terminal.
- all:
  Retrieve dwell statistics for all containers that are in yard inventory as well as containers that have already left the terminal.

  - `trade_type` (string)
    - import:
  Retrieve dwell statistics only for containers with import trade type.
- export:
  Retrieve dwell statistics only for containers with export trade type.

If trade type is empty, dwell statistics for all trade types (import and export) will be retrieved.

## Response 200 fields (application/json):

  - `terminal_id` (string)
    The terminal ID refers to the unique identifier of the terminal for which the dwell time is being calculated.

  - `start_dttm` (string)

  - `end_dttm` (string)
    Include all containers discharged  prior to this date/time in dwell aggregation

  - `container_count` (integer)
    Number of containers counted in dwell aggregation

  - `avg_dwell_time` (number)
    Average dwell time in hours

  - `teu` (number)
    Total TEU of all containers matching search criteria

  - `date_aggregated_dttm` (string,null)
    Date represents last modification date of records


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 500 fields