VRt.Monitor [MT] (7.16.2673)

Veeroute Support Team: servicedesk@veeroute.com License: Proprietary Terms of Service

Veeroute Monitor API.

Veeroute company website

Description

Server part of the Veeroute Monitor.

Entity relationship diagram

erd

Accounts

Accounts management.

Analytics

Analytics and reports.

Waves

Waves management.

Trips

Trips management.

Read trip

Getting trip information by key.

Authorizations:

ApiKeyAuth

path Parameters

essence_key

required

string or null (basic_essence_key) [ 1 .. 1024 ] characters

Default: null

Example: key01

Key, unique identifier.

Responses

Response Schema: application/json

required	object (trip) A trip is a set of works planned to be performed by a specific performer on a specific transport, expressed through a change in the states of the performer.
required	object (trip_statistics) Statistics for a specific trip.
	object (table_trip_fields) Trip\stops fields for table.
	Array of objects (linked_essence_list) [ 0 .. 15001 ] items A list of linked essences.

Response samples

Content type

application/json

{"trip": {"key": "trip-0000-9999",
"performer": {"performer_key": "performer0001",
"shift_key": "performer0001_shift01",
"shift_time": {"from": "2025-03-21T09:30:00+03:00",
"to": "2025-03-21T19:45:00Z"
}
},
"transport": {"transport_key": "transport001",
"shift_key": "performer01",
"shift_time": {"from": "2025-03-21T09:30:00+03:00",
"to": "2025-03-21T19:45:00Z"
}
},
"states": [{"time": "2025-03-21T09:30:00+03:00",
"order_key": "order01",
"demand_key": "demand01.1",
"event_key": "event01",
"location_key": "location_01",
"flags": ["RELOCATING"
],
"cargo_actions": [{"box_key": "box01",
"cargo_key": "cargo01",
"cargo_action_type": "ADD"
}
],
"distance": 5200,
"cost": 1231.1,
"reward": 2343.3,
"attributes": [ ]
}
],
"waitlist": ["order02"
],
"name": "X1-ABC",
"attributes": [ ]
},
"trip_statistics": {"trip_key": "trip01",
"general_statistics": {"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"measurements": {"time_window": {"from": "2025-03-21T09:30:00+03:00",
"to": "2025-03-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_sum": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
},
"cargo_capacity_ratio": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"max_transport_load": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"average_speed": 43.1,
"round_trips_count": 2,
"average_roundtrip_distance": 23.4,
"average_roundtrip_time": "PT1H45M",
"attributes": [ ]
},
"load_statistics": {"total_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_transfer_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
},
"stop_statistics": [{"location_key": "location_01",
"stop_demands": [{"demand_key": "demand_key_01",
"event_key": "event_key_01",
"demand_time_window": {"from": "2025-03-21T09:30:00+03:00",
"to": "2025-03-21T19:45:00Z"
}
}
],
"stop_time_window": {"from": "2025-03-21T09:30:00+03:00",
"to": "2025-03-21T19:45:00Z"
},
"measurements": {"time_window": {"from": "2025-03-21T09:30:00+03:00",
"to": "2025-03-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"upload": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"download": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"max_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"arrival_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
},
"departure_load": {"count": 1460,
"capacity": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
}
}
}
],
"roundtrip_statistics": [{"roundtrip_key": "trip_01_round_02",
"general_statistics": {"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"measurements": {"time_window": {"from": "2025-03-21T09:30:00+03:00",
"to": "2025-03-21T19:45:00Z"
},
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"working_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200
},
"trips_count": 250,
"performers_count": 157,
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_sum": {"mass": 105500,
"volume": 220034,
"capacity_a": 100000,
"capacity_b": 200000,
"capacity_c": 300000
},
"cargo_capacity_ratio": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"max_transport_load": {"mass": 0.5,
"volume": 0.1,
"capacity_a": 0.7,
"capacity_b": 0.8,
"capacity_c": 0.9
},
"average_speed": 43.1,
"round_trips_count": 2,
"average_roundtrip_distance": 23.4,
"average_roundtrip_time": "PT1H45M",
"attributes": [ ]
}
}
],
"attributes": [ ]
},
"fields": {"essence_type": "TRIP",
"essence_key": "key01",
"enabled": false,
"pristine": false,
"trip_name": "X1-ABC",
"cost": 1231.1,
"reward": 2343.3,
"profit": 1231.1,
"driving_time": "PT1H45M",
"waiting_time": "PT1H45M",
"break_time": "PT1H45M",
"rest_time": "PT1H45M",
"working_time": "PT1H45M",
"arriving_time": "PT1H45M",
"departure_time": "PT1H45M",
"total_time": "PT1H45M",
"distance": 5200,
"time_window": {"from": "2025-03-21T08:45:00+03:00",
"to": "2025-03-21T19:45:00+03:00"
},
"orders_count": 1700,
"plan_orders_count": 1003,
"waitlist_orders_count": 697,
"stops_count": 87,
"locations_count": 45,
"cargo_capacity_ratio_mass": 10,
"cargo_capacity_ratio_volume": 2,
"cargo_capacity_ratio_capacity_a": 1,
"cargo_capacity_ratio_capacity_b": 2,
"cargo_capacity_ratio_capacity_c": 3,
"max_transport_load_mass": 0.1,
"max_transport_load_volume": 0.1,
"max_transport_load_capacity_a": 0.1,
"max_transport_load_capacity_b": 0.1,
"max_transport_load_capacity_c": 0.1,
"attributes": "key1:value1, key2:value2",
"customfields": {"datetime_1": "2025-03-21T18:00:00+03:00",
"datetime_2": "2025-03-21T18:00:00+03:00",
"datetime_3": "2025-03-21T18:00:00+03:00",
"datetime_4": "2025-03-21T18:00:00+03:00",
"datetime_5": "2025-03-21T18:00:00+03:00",
"int_1": 1,
"int_2": 1,
"int_3": 1,
"int_4": 1,
"int_5": 1,
"float_1": 2343.3,
"float_2": 2343.3,
"float_3": 2343.3,
"float_4": 2343.3,
"float_5": 2343.3,
"duration_1": "PT2H12M34.3S",
"duration_2": "PT2H12M34.3S",
"duration_3": "PT2H12M34.3S",
"duration_4": "PT2H12M34.3S",
"duration_5": "PT2H12M34.3S",
"bool_1": true,
"bool_2": true,
"bool_3": true,
"bool_4": true,
"bool_5": true,
"string_1": "value01",
"string_2": "value01",
"string_3": "value01",
"string_4": "value01",
"string_5": "value01"
}
},
"linked_essences": [{"essence_key": "key01",
"essence_type": "LOCATION"
}
]
}

System

System functions. Auxiliary functionality common to all services.

Checking the availability

Checking the service availability.

Responses

Response Schema: application/json

health

required

number <double> [ 0 .. 1 ]

Example: "0.999"

The current health indicator of the service.

0.0 means the service is not ready to perform tasks.
1.0 means the service is fully ready to perform tasks.

Response samples

200
404
429
500

Content type

application/json

{"health": 0.999
}

Getting the service version

Getting the service version.

Responses

Response Schema: application/json

major required	integer <int32> [ 1 .. 100 ] Example: "7" Product version. Within a single version, compatibility of common data structures between services is guaranteed. A version change indicates changes that are incompatible with previous versions of the product (and all services).
minor required	integer <int32> [ 0 .. 111 ] Example: "15" Minor version of the service. A version change indicates new functionality. The update is backward compatible with the major version of the service.
build required	string [ 1 .. 64 ] characters Example: "3754RC" Build version. Contains backwards compatible bug fixes and docs update.

Response samples

200
404
429
500

Content type

application/json

{"major": 7,
"minor": 15,
"build": "3754RC"
}

Getting the documentation

Getting the file with this service documentation.

path Parameters

filename

required

string [ 6 .. 128 ] characters

Example: file_en.html

File name.

Responses

Response Schema:
text/html

string (file_html)

File with data in HTML format.

Response samples

404
429
500

Content type

application/json

{"resource_key": "resource_key",
"detail": {"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2025-03-21T09:30:00+03:00"
}
}
}

VRt.Monitor [MT] (7.16.2673)

Description

Entity relationship diagram

Accounts

Analytics

Waves

Trips

Read trip

Authorizations:

path Parameters

Responses

Response Schema: application/json

Response samples

System

Checking the availability

Responses

Response Schema: application/json

Response samples

Getting the service version

Responses

Response Schema: application/json

Response samples

Getting the documentation

path Parameters

Responses

Response Schema: text/htmltext/plaintext/html

Response samples

Response Schema:
text/html