Loadsmart

Loadsmart Metrics API

The Metrics API from Loadsmart — 23 operation(s) for metrics.

Documentation GitHub OpenAPI

Operations 23

GET /metrics/appointment-volume/load-type Appointment volume by load type and week day #

GET /metrics/appointment-volume/time-of-day Appointment volume by time of day #

GET /metrics/appointment-volume/date Appointment volume by date #

GET /metrics/appointment-volume/carrier Appointment volume by carrier #

GET /metrics/appointment-volume/average-duration-by-load-type Appointment duration average by load type #

GET /metrics/appointment-volume/day-of-week Appointment duration average by dock and day of week #

GET /metrics/appointment-volume/status Appointment duration average by status #

GET /metrics/appointment-volume/status-by-dock Appointment duration average by dock and status #

POST /metrics/appointments/status-times The average time spent in each appointment status #

POST /metrics/appointments/excel Retrieve file link with the appointment list that matches the criteria… #

POST /metrics/yard/excel Retrieve file link with the yard data list that matches the criteria described… #

POST /metrics/asset-visits/excel Retrieve file link with the asset visits (check-ins) list that matches the… #

POST /metrics/warehouse/capacity-usage Retrieve warehouse dock capacity usage information per warehouse #

POST /metrics/warehouse Retrieve warehouse insights #

GET /metrics/carrier/status-percentages Retrieve carrier insights data with each status percentage #

GET /metrics/dock/dwell-time Retrieve dock metrics of dwell time by day of week #

GET /metrics/counts/appointment-count-for-docks Appointment count per dock #

GET /metrics/counts/appointment-count-for-carrier Appointment count per carrier #

GET /metrics/counts/appointment-count-for-carrier/status Appointment count by status for current carrier #

GET /metrics/counts/reserve-count-for-user Reserve count for user #

POST /metrics/loadtype/first-avail-appt Finds the next available appointment time for each dock and loadtype, starting… #

POST /metrics-v2/appointments Retrieve an appointment list that matches the criteria described in the request… #

POST /metrics-v2/asset-visits Retrieve an asset visit list that matches the criteria described in the request… #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/loadsmart-metrics-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Opendock Nova API Documentation Metrics API
  description: '## Welcome to Opendock Nova!'
  version: v4.144.0 - 39b4253
  contact: {}
servers:
- url: https://neutron.opendock.com
  description: Production Server
- url: https://neutron.staging.opendock.com
  description: Staging Server
tags:
- name: Metrics
paths:
  /metrics/appointment-volume/load-type:
    get:
      operationId: MetricsController_getLoadTypeVolume
      summary: Appointment volume by load type and week day
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsAppointmentVolumeByLoadTypeResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/appointment-volume/time-of-day:
    get:
      operationId: MetricsController_getTimeOfDayVolume
      summary: Appointment volume by time of day
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsAppointmentVolumeByTimeOfDayResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/appointment-volume/date:
    get:
      operationId: MetricsController_getDateVolume
      summary: Appointment volume by date
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsAppointmentVolumeByDateResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/appointment-volume/carrier:
    get:
      operationId: MetricsController_getCarrierVolume
      summary: Appointment volume by carrier
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsAppointmentVolumeByCarrierResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/appointment-volume/average-duration-by-load-type:
    get:
      operationId: MetricsController_getAverageDurationByLoadType
      summary: Appointment duration average by load type
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsAverageDurationByLoadTypeResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/appointment-volume/day-of-week:
    get:
      operationId: MetricsController_getDayOfWeekVolume
      summary: Appointment duration average by dock and day of week
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsAppointmentVolumeByDayOfWeekResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/appointment-volume/status:
    get:
      operationId: MetricsController_getStatusVolume
      summary: Appointment duration average by status
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsAppointmentVolumeByStatusResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/appointment-volume/status-by-dock:
    get:
      operationId: MetricsController_getStatusByDockVolume
      summary: Appointment duration average by dock and status
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsAppointmentVolumeByStatusByDockResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/appointments/status-times:
    post:
      operationId: MetricsController_getStatusTimes
      summary: The average time spent in each appointment status
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppointmentMetricsDto'
      responses:
        '201':
          description: ''
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/appointments/excel:
    post:
      operationId: MetricsController_getExcelReport
      summary: Retrieve file link with the appointment list that matches the criteria…
      description: The link will point to an XLSX file external to Nova
      parameters:
      - name: emailCCs
        required: true
        in: query
        schema:
          type: array
          items:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppointmentMetricsListDto'
      responses:
        '201':
          description: ''
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/yard/excel:
    post:
      operationId: MetricsController_getYardExcelReport
      summary: Retrieve file link with the yard data list that matches the criteria described…
      description: The link will point to an XLSX file external to Nova
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/YardExportDataDto'
      responses:
        '201':
          description: ''
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/asset-visits/excel:
    post:
      operationId: MetricsController_getAssetVisitExcelReport
      summary: Retrieve file link with the asset visits (check-ins) list that matches the…
      description: The link will point to an XLSX file external to Nova
      parameters:
      - name: emailCCs
        required: true
        in: query
        schema:
          type: array
          items:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetVisitExcelExportDto'
      responses:
        '201':
          description: ''
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/warehouse/capacity-usage:
    post:
      operationId: MetricsController_getWarehouseCapacityUsage
      summary: Retrieve warehouse dock capacity usage information per warehouse
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppointmentMetricsCapacityDto'
      responses:
        '201':
          description: ''
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/warehouse:
    post:
      operationId: MetricsController_getWarehouseMetrics
      summary: Retrieve warehouse insights
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WarehouseMetricsDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsCarrierStatusPercentageResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/carrier/status-percentages:
    get:
      operationId: MetricsController_getCarrierStatusPercentages
      summary: Retrieve carrier insights data with each status percentage
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsCarrierStatusPercentageResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/dock/dwell-time:
    get:
      operationId: MetricsController_getDockDwellTime
      summary: Retrieve dock metrics of dwell time by day of week
      parameters:
      - name: fromDate
        required: false
        in: query
        description: From date to filter
        schema: {}
      - name: toDate
        required: false
        in: query
        description: To date to filter
        schema: {}
      - name: warehouseId
        required: false
        in: query
        description: Warehouse ID to filter
        schema: {}
      - name: dockId
        required: false
        in: query
        description: Dock ID to filter
        schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsDockDwellTimeResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/counts/appointment-count-for-docks:
    get:
      operationId: MetricsController_getAppointmentCountForDocks
      summary: Appointment count per dock
      parameters:
      - name: dockIds
        required: true
        in: query
        description: Dock IDs array
        schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsCountsAppointmentCountForDocksResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/counts/appointment-count-for-carrier:
    get:
      operationId: MetricsController_getAppointmentCountForCarrier
      summary: Appointment count per carrier
      parameters:
      - name: carrierId
        required: true
        in: query
        description: Carrier ID
        schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsCountsAppointmentCountForCarrierResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/counts/appointment-count-for-carrier/status:
    get:
      operationId: MetricsController_getAppointmentCountByStatusForCarrier
      summary: Appointment count by status for current carrier
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/counts/reserve-count-for-user:
    get:
      operationId: MetricsController_getReserveCountForUser
      summary: Reserve count for user
      parameters:
      - name: userId
        required: false
        in: query
        description: User ID
        schema: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsCountsReserveCountForUserResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics/loadtype/first-avail-appt:
    post:
      operationId: MetricsController_getFirstAvailAppts
      summary: Finds the next available appointment time for each dock and loadtype, starting…
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoadTypeMetricsDto'
      responses:
        '201':
          description: ''
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics-v2/appointments:
    post:
      operationId: MetricsV2Controller_getAppointmentsList
      summary: Retrieve an appointment list that matches the criteria described in the request…
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppointmentMetricsListV2Dto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsAppointmentListResponse'
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
  /metrics-v2/asset-visits:
    post:
      operationId: MetricsV2Controller_getAssetVisitsList
      summary: Retrieve an asset visit list that matches the criteria described in the request…
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetVisitMetricsListDto'
      responses:
        '200':
          description: ''
      tags:
      - Metrics
      security:
      - bearer: []
      - bearer: []
components:
  schemas:
    AppointmentMetricsDto:
      type: object
      properties: {}
    MetricsAppointmentVolumeByLoadTypeResponse:
      type: object
      properties:
        data:
          type: object
          example:
            MyLoadType:
              sunday: 0
              monday: 3
              tuesday: 2
              wednesday: 5
              thursday: 7
              friday: 5
              saturday: 0
            AnotherLoadType:
              sunday: 0
              monday: 2
              tuesday: 3
              wednesday: 2
              thursday: 5
              friday: 4
              saturday: 0
      required:
      - data
    MetricsDockDwellTimeResponse:
      type: object
      properties:
        data:
          type: object
          example:
            day:
              Dock2:
                Tuesday: 45
                Friday: 30
              MyDock:
                Monday: 30
                Tuesday: 45
            all:
              Dock2: 45
              MyDock: 45
      required:
      - data
    MetricsCountsReserveCountForUserResponse:
      type: object
      properties:
        data:
          type: object
          example:
            reserveCount: 3
      required:
      - data
    MetricsAppointmentListResponse:
      type: object
      properties: {}
    MetricsAppointmentVolumeByStatusResponse:
      type: object
      properties:
        data:
          type: object
          example:
            Scheduled: '6'
            Arrived: '2'
            Completed: '5'
            NoShow: '1'
            Cancelled: '0'
      required:
      - data
    MetricsAppointmentVolumeByTimeOfDayResponse:
      type: object
      properties:
        data:
          type: object
          example:
            '8': '1'
            '9': '1'
            '10': '2'
            '11': '2'
            '13': '4'
            '14': '4'
            '15': '3'
            '16': '3'
      required:
      - data
    AssetVisitMetricsListDto:
      type: object
      properties:
        warehouseIds:
          type: array
          items:
            type: string
        carrierIds:
          type: array
          items:
            type: string
        statuses:
          type: array
          items:
            type: string
            enum:
            - Arrived
            - Docked
            - Departed
            - Canceled
        fromDate:
          type: string
        toDate:
          type: string
        dateField:
          type: string
          enum:
          - checkInDate
          - checkOutDate
        page:
          type: number
        pageSize:
          type: number
        exportFields:
          type: array
          items:
            type: string
      required:
      - page
      - pageSize
    AppointmentMetricsListDto:
      type: object
      properties:
        limit:
          type: number
        dockIds:
          type: array
          items:
            type: string
        loadTypeIds:
          type: array
          items:
            type: string
        carrierIds:
          type: array
          items:
            type: string
        tags:
          type: array
          items:
            type: string
        dateField:
          type: object
        appointmentTypes:
          type: array
          items:
            type: string
        allCarriers:
          type: boolean
        exportFields:
          type: array
          items:
            type: string
        skipCustomFields:
          type: boolean
    MetricsCarrierStatusPercentageResponse:
      type: object
      properties:
        data:
          type: object
          example:
            list:
            - id: 2968b3b1-ffe0-4005-8114-7c584e0893f6
              name: Carrier 1
              scac: 99M
              appointmentIds:
              - 6eae2369-9c29-4f23-b091-24d831112b9f
              - c66fef39-66ea-4249-8c67-23ecf6710ba3
              totalAppointments: '2'
              totalLateAppointments: '0'
              totalOnTimeAppointments: '1'
              totalNoShowAppointments: '0'
              totalRescheduledAppointments: '0'
              totalCancelledAppointments: '1'
              onTimePct: '50.0'
              latePct: '0.0'
              noShowPct: '0.0'
              rescheduledPct: '0.0'
              cancelPct: '50.0'
              avgCancelLeadTimeInMinutes: '-149.2320333333333333'
            - id: 3c36909b-1a09-462f-99e1-a9152b3306d0
              name: Carrier2
              scac: 98M
              appointmentIds:
              - 0a5cc02a-fdda-4645-8b7c-3097ec6b5a16
              - 27de0365-b6fc-4cdc-a586-a2a3a1b3036b
              - 29b270d5-4148-4a0b-9439-30fd9a7329ac
              - 315e19d0-574d-4f55-8728-c4c3fba71c1c
              - 89c390b7-9e78-4852-b67d-db4250a27256
              - a8fa27d4-f441-4f5c-8dc5-9c1e1dd213f1
              totalAppointments: '11'
              totalLateAppointments: '5'
              totalOnTimeAppointments: '0'
              totalNoShowAppointments: '2'
              totalRescheduledAppointments: '1'
              totalCancelledAppointments: '0'
              onTimePct: '0.0'
              latePct: '45.5'
              noShowPct: '18.2'
              rescheduledPct: '9.1'
              cancelPct: '0.0'
              avgCancelLeadTimeInMinutes: null
            total:
              totalCarriers: 2
              totalAppointments: 13
              avgAppointmentsPerCarrier: 6
              totalOnTimeAppointments: 1
              totalLateAppointments: 5
              totalNoShowAppointments: 2
              totalRescheduledAppointments: 1
              totalCancelledAppointments: 1
              onTimePct: '7.7'
              latePct: '38.5'
              cancelPct: '7.7'
              noShowPct: '15.4'
              rescheduledPct: '7.7'
              avgCancelLeadTimeInMinutes: -75
      required:
      - data
    MetricsCountsAppointmentCountForDocksResponse:
      type: object
      properties:
        data:
          type: object
          example:
          - dock_id: c09e393a-0916-444a-a1a8-4e605a07618e
            count: 72
      required:
      - data
    MetricsCountsAppointmentCountForCarrierResponse:
      type: object
      properties:
        data:
          type: object
          example:
          - org_name: My carrier org name
            appointmentCount: 45
      required:
      - data
    MetricsAppointmentVolumeByCarrierResponse:
      type: object
      properties:
        data:
          type: object
          example:
            Raphael: '5'
            Josh: '7'
            Mike: '3'
      required:
      - data
    WarehouseMetricsDto:
      type: object
      properties: {}
    MetricsAppointmentVolumeByStatusByDockResponse:
      type: object
      properties:
        data:
          type: object
          example:
            MyDock:
              Scheduled: '6'
              Arrived: '2'
              Completed: '5'
              NoShow: '1'
              Cancelled: '0'
            AlternativeDock:
              Scheduled: '1'
              Arrived: '2'
              Completed: '2'
              NoShow: '1'
              Cancelled: '0'
      required:
      - data
    MetricsAverageDurationByLoadTypeResponse:
      type: object
      properties:
        data:
          type: object
          example:
            MyLoadType: 36
            AnotherLoadType: 20
      required:
      - data
    LoadTypeMetricsDto:
      type: object
      properties: {}
    AppointmentMetricsCapacityDto:
      type: object
      properties:
        dockIds:
          type: array
          items:
            type: string
    MetricsAppointmentVolumeByDateResponse:
      type: object
      properties:
        data:
          type: object
          example:
            05/16/2023: '1'
            05/30/2023: '1'
            06/02/2023: '1'
            06/09/2023: '2'
      required:
      - data
    AppointmentMetricsListV2Dto:
      type: object
      properties:
        dockIds:
          type: array
          items:
            type: string
        loadTypeIds:
          type: array
          items:
            type: string
        carrierIds:
          type: array
          items:
            type: string
        tags:
          type: array
          items:
            type: string
        dateField:
          type: object
        appointmentTypes:
          type: array
          items:
            type: string
        allCarriers:
          type: boolean
        exportFields:
          type: array
          items:
            type: string
        skipCustomFields:
          type: boolean
    YardExportDataDto:
      type: object
      properties: {}
    MetricsAppointmentVolumeByDayOfWeekResponse:
      type: object
      properties:
        data:
          type: object
          example:
            MyDock:
              sunday: 0
              monday: 6
              tuesday: 2
              wednesday: 3
              thursday: 7
              friday: 3
              saturday: 0
            AlternativeDock:
              sunday: 0
              monday: 2
              tuesday: 2
              wednesday: 1
              thursday: 3
              friday: 2
              saturday: 0
      required:
      - data
    AssetVisitExcelExportDto:
      type: object
      properties:
        warehouseIds:
          type: array
          items:
            type: string
        carrierIds:
          type: array
          items:
            type: string
        statuses:
          type: array
          items:
            type: string
            enum:
            - Arrived
            - Docked
            - Departed
            - Canceled
        fromDate:
          type: string
        toDate:
          type: string
        dateField:
          type: string
          enum:
          - checkInDate
          - checkOutDate
        exportFields:
          type: array
          items:
            type: string
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http