Read routing results
curl --request GET \
--url https://apiweb.mile.app/api/v3/results \
--header 'Authorization: Bearer <token>'import requests
url = "https://apiweb.mile.app/api/v3/results"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apiweb.mile.app/api/v3/results', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiweb.mile.app/api/v3/results",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apiweb.mile.app/api/v3/results"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apiweb.mile.app/api/v3/results")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiweb.mile.app/api/v3/results")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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": "« 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 »",
"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
}{
"status": false,
"message": "Bad request - invalid parameters provided."
}{
"status": false,
"message": "Internal server error, please contact support@mile.app."
}Routing
Read routing results
This API endpoint allows you to retrieve a list of routing optimization results by specifying different parameters for filtering and sorting.
GET
/
results
Read routing results
curl --request GET \
--url https://apiweb.mile.app/api/v3/results \
--header 'Authorization: Bearer <token>'import requests
url = "https://apiweb.mile.app/api/v3/results"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://apiweb.mile.app/api/v3/results', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiweb.mile.app/api/v3/results",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://apiweb.mile.app/api/v3/results"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://apiweb.mile.app/api/v3/results")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiweb.mile.app/api/v3/results")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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": "« 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 »",
"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
}{
"status": false,
"message": "Bad request - invalid parameters provided."
}{
"status": false,
"message": "Internal server error, please contact support@mile.app."
}Authorizations
Use a valid Bearer token to authenticate.
Query Parameters
An unique value for result optimization data serving as an alternative identifier. Example: Route-20230801-001
The page number of results to retrieve. Example: 2
Specifies the maximum number of items to retrieve in a single request. Example: 10
Required range:
1 <= x <= 1000Search routing results by result name or assignee email. Example: routing
Sort the result-set in ascending or descending order based on selected field.
Example: name, hubId, hubCoordinate, etc. Default: createdTime
Choose ascending or descending order for sorting the results. Example: asc or desc. Default: desc
List of fields to include in the response, separated by comma (,) delimiter.
Example: createdTime,configurationId,createdBy,resultTotal,name,configuration
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
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
⌘I