# Retrieve Metrics About Appointment Availability

This API endpoint returns appointment availability statistics for time slotted appointments. This API returns data only for the time slotted appointment move types and does not include pre-advice information
as it is not applicable as an appointment availability statistic.
The response will contain appointment availability data starting with the current date and 7 days into the future and contain a listing of
available and booked appointments by move type and time slot for a specific terminal.

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

## Path parameters:

  - `terminal_id` (string, required)
    The input is the terminal GUID received from the first API call and embed it along the URL to get the details of the specific terminal.

  - `version` (string, required)

## Response 200 fields (application/json):

  - `appointments` (array,null)

  - `appointments.date_aggregated_dttm` (string)
    Request date and time in UTC time zone

  - `appointments.date` (string,null)
    Appointment business date

  - `appointments.move_type` (array,null)
    Appointment move type
IP Import Container Pickup,
MD Drop Empty Container, 
MP Pickup Empty Container,
XD Drop Export Container, 
XP Pickup Dray (Export) Container, 
ID Drop Dray (Import) Container, 
BD Drop Bare Chassis,
BP Pickup Bare Chassis         ///

  - `appointments.move_type_desc` (array,null)
    Full description of the move type

  - `appointments.slot_desc` (string,null)
    Appointment time slot description

  - `appointments.slot_start_dttm` (string)
    Appointment slot start date time

  - `appointments.slot_end_dttm` (string)
    Appointment slot end date time

  - `appointments.total_appointments` (integer)
    Total appointments made available by the terminal for this time slot and move type

  - `appointments.allocated_appointments` (integer)
    Number of appointments booked/consumed for this time slot and move type. This includes all the appointments in pending, confirmed, and completed statuses.

  - `appointments.blocked_flag` (string,null)
    An indicator if the time slot is blocked for future appointments.


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 500 fields