Skip to main content
GET
/
results
Read routing results
curl --request GET \
  --url https://apiweb.mile.app/api/v3/results \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "current_page": 1,
    "data": [
      {
        "_id": "6352736c628401059b37a2e2",
        "name": "Result Today",
        "configurationId": null,
        "configuration": {
          "defaultVisitTime": 10,
          "defaultSpeed": 15,
          "multitrip": false,
          "returnToHub": true,
          "useAllVehicle": false,
          "clustering": false,
          "capacityConstraint": [
            "weight"
          ],
          "name": "Configuration Default",
          "autoSpeed": false,
          "autoSplit": "none",
          "useOddEven": true,
          "oddEvenTime": [
            {
              "startTime": "07:00",
              "endTime": "10:00"
            },
            {
              "startTime": "17:00",
              "endTime": "20:00"
            }
          ]
        },
        "routingDate": "2023-08-08",
        "resultCode": "1129812812",
        "finishTime": "2023-02-06T01:20:36+00:00",
        "updatedTime": "2023-02-06T01:20:36+00:00",
        "createdTime": "2023-02-06T01:18:36+00:00",
        "resultTotal": {
          "routing": 1,
          "dropped": 1,
          "total": 2
        },
        "createdBy": "635f6a9a8e47b604ed5f5e08",
        "user": {
          "name": "Marshall Teach"
        }
      }
    ],
    "first_page_url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=45",
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "active": false
      },
      {
        "url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=1",
        "label": "1",
        "active": true
      },
      {
        "url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=2",
        "label": "2",
        "active": false
      },
      {
        "url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=3",
        "label": "3",
        "active": false
      },
      {
        "url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=4",
        "label": "4",
        "active": false
      },
      {
        "url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=5",
        "label": "5",
        "active": false
      },
      {
        "url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=6",
        "label": "6",
        "active": false
      },
      {
        "url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=7",
        "label": "7",
        "active": false
      },
      {
        "url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=8",
        "label": "8",
        "active": false
      },
      {
        "url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=9",
        "label": "9",
        "active": false
      },
      {
        "url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=10",
        "label": "10",
        "active": false
      },
      {
        "url": null,
        "label": "...",
        "active": false
      },
      {
        "url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=44",
        "label": "44",
        "active": false
      },
      {
        "url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=45",
        "label": "45",
        "active": false
      },
      {
        "url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=2",
        "label": "Next &raquo;",
        "active": false
      }
    ],
    "next_page_url": "https://apiweb.mile.app/api/v3/results?hubId=635f6ad98e47b604ed5f5e09&limit=10&sortBy=createdTime&sortOrder=DESC&fields=createdTime%2CconfigurationId%2CcreatedBy%2CresultTotal%2Cname%2Cconfiguration&page=2",
    "path": "https://apiweb.mile.app/api/v3/results",
    "per_page": 10,
    "prev_page_url": null,
    "to": 10,
    "total": 1
  },
  "status": true
}

Authorizations

​
Authorization
string
header
required

Use a valid Bearer token to authenticate.

Query Parameters

​
resultCode
string

An unique value for result optimization data serving as an alternative identifier. Example: Route-20230801-001

​
hubId
string

Fundamental entity within an organization, serving as the central point for managing various operational components. Use Use GET /hubs endpoint to get the list of Hub IDs. Example: 634e98498ce07d29474a7e29

​
page
integer
default:1

The page number of results to retrieve. Example: 2

​
limit
integer
default:20

Specifies the maximum number of items to retrieve in a single request. Example: 10

Required range: 1 <= x <= 1000
​
s
string

Search routing results by result name or assignee email. Example: routing

​
sortBy
string

Sort the result-set in ascending or descending order based on selected field. Example: name, hubId, hubCoordinate, etc. Default: createdTime

​
sortOrder
string

Choose ascending or descending order for sorting the results. Example: asc or desc. Default: desc

​
fields
string

List of fields to include in the response, separated by comma (,) delimiter. Example: createdTime,configurationId,createdBy,resultTotal,name,configuration

​
dateFrom
string

Retrieves results starting from this date onwards. Supports the following formats: Y-m-d Example: 2023-08-08 Y-m-d H:i:S Example: 2023-08-08 00:00:00 Y-m-dTH:i:s.sssZ. Example: 2023-08-08T00:00:00.000Z

​
dateTo
string

Retrieves results up to this specified date. Use in combination with dateFrom to define a date range. Supports the following formats: Y-m-d Example: 2023-08-08 Y-m-d H:i:S Example: 2023-08-08 00:00:00 Y-m-dTH:i:s.sssZ. Example: 2023-08-08T00:00:00.000Z

Response

Success

​
status
string

Status of response.

​
data
object[]

Object of pagination data.