• Home
  • Guides
  • Reference
  • Support
Search Results for

    Show / Hide Table of Contents
    • API Overview
      • Overview
      • Authentication
      • Retrieving API Results
      • Referenced vs Inline Entities
      • Choosing API Response Data
      • Handling API Errors
    • separator
    • Vehicle Routing Endpoints
      • Path
    • Optimization Endpoints
      • Instantiate
      • Build
      • Assignment Restrictions
      • Optimize
      • Sequence
      • Evaluate
      • Recommend
      • Insert
      • Centroids
      • Zones
      • Consolidate By Job Restrictions
      • Consolidate By Route Assignments
    • Geocoding Endpoints
      • Geocode
      • Reverse Geocode
    • Task Endpoints
      • List
      • Status
      • Result
      • Cancel
    • Sandbox Endpoints
      • List
      • Create
      • Rename
      • Retrieve
      • Update
      • Delete
      • Revisions
      • Add Revision
      • Expiry
      • Permissions
    • Verizon Connect Fleet Integration Endpoints
      • Pull Platform Data
      • Sync Platform Data
      • List Platform Territories
    • Other Endpoints
      • Canonicalize
      • Route Cards
      • Validate
      • Version
    • separator
    • Request Types
      • problem
      • capacity_metric
      • depot
      • driver
      • driver_break
      • job
      • job_template
      • job_type
      • load_amount
      • marker
      • problem_defaults
      • route
      • schedule
      • settings
      • shift
      • shift_override
      • shift_pattern
      • shift_pattern_assignment
      • stop
      • vehicle
      • zone
      • variance
    • Response Types
      • instantiate_response
      • problem_response
      • problem_aggregates
      • driver_response
      • geocoded_location
      • recommend_option
      • route_response
      • schedule_response
      • schedule_instantiate_response
      • stop_response
      • violation
    • Meta Types
      • task_redirect_response
      • task_status_response
      • validate_response
    • Sandbox Types
      • delta
      • array_delta
      • dict_delta
      • keyed_array_delta
      • object_delta
      • set_delta
      • revision
      • revision_created_response
      • revision_response
      • sandbox_response
    • Common Types
      • date_range
      • day_of_week
      • hazmat_load_type
      • id
      • latlon
      • stop_type
      • time_window
      • custom
      • polygon
    • Primitive Types
      • boolean
      • date
      • datetime
      • float
      • integer
      • string
      • timespan

    problem_aggregates

    A problem_aggregates object provides a basic overview of the vital values of a problem. It can be returned instead of a full evaluate_response from an evaluate call, or instead of a full problem from a sandbox retrieve.

    Name Type Description
    capacity_metrics capacity_metric[] Details of the metrics used to measure job loads.
    load float The total amount of load delivered at all routed jobs. Not compatible with loads. See Routing with Capacities.
    loads load_amount[] The total amount of load delivered at all routed jobs per metric. Omitted metrics indicate an amount of 0. Not compatible with load. See Routing with Capacities and load_amount.
    num_assigned_jobs integer The total number of jobs that are assigned to routes.
    num_drivers_used integer The total number of drivers that are used in this problem. A driver is considered to be "used" used if they have at least one non-empty route.
    num_routes integer The total number of routes in the problem.
    num_unassigned_jobs integer The total number of jobs that are not assigned to routes.
    num_violations integer The total number of violations across all routes and stops in the problem. Not returned from a sandboxes_retrieve call.
    total_cost float The total projected cost of all routes in the problem. Not returned from a sandboxes_retrieve call.
    total_distance_meters float The total projected distance of all the routes in the problem, in meters. Not returned from a sandboxes_retrieve call.
    total_driving_time timespan The total projected time spent driving all the routes in the problem. Not returned from a sandboxes_retrieve call.
    total_internal_cost float The total projected cost of all the routes in the problem, including violations and intangibles. Not returned from a sandboxes_retrieve call.
    total_working_time timespan The total projected time taken to complete all the routes in the problem. Not returned from a sandboxes_retrieve call.

    Example

    {
      "num_routes": 2,
      "num_assigned_jobs": 12,
      "num_unassigned_jobs": 0,
      "num_drivers_used": 0,
      "total_cost": 205.1,
      "total_internal_cost": 20476.86,
      "total_distance_meters": 335464,
      "total_working_time": "09:12:02",
      "total_driving_time": "05:52:56",
      "num_violations": 1
    }
    

    See Also

    • The evaluate endpoint.
    • The sandbox retrieve method.
    • problem.
    • @evaluate_response.
    In this article
    Back to top
    © 2023 Verizon. All rights reserved. Verizon Privacy policy California Privacy Notice Your Privacy Choices Privacy request