VRt.Monitor
VEEROUTE 2026

VRt.Monitor [MT] (7.33.3222)

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

Veeroute Monitor API.

Veeroute company website

Description

Server part of the Veeroute Monitor.

Entity relationship diagram

erd

Explorer

Virtual filesystem management.

Create folder

Create new folder.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Request to create a folder. In the parent_key field, you must specify the key of the folder in which the new folder will be created. If parent_key is not specified, the folder is created in the root.

parent_key
string or null <uuid> (folder_parent_key)
Example: "11111111-2222-3333-4444-555555555555"

Parent folder key, null if the folder is root.

name
required
string (folder_name) [ 1 .. 100 ] characters
Example: "folder_1"

Folder name.

comment
string or null (folder_comment) [ 0 .. 10000 ] characters
Example: "long long long long text"

Folder comment.

color
string or null (folder_color) [ 1 .. 20 ] characters
Example: "red"

Folder color.

expiration_date
string or null <date-time> (folder_expiration_date)
Example: "2026-04-21T19:45:00Z"

Date and time of automatic deletion in the ISO 8601 format. Null means that automatic deletion does not occur.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
string <uuid> (unique_key)

New folder key.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

Getting a filesystem

Getting a filesystem.

Authorizations:
ApiKeyAuth
query Parameters
folder_key
string <uuid> (unique_key)
Example: folder_key=11111111-2222-3333-4444-555555555555

Parent folder key, if not specified - a list of root folders is returned

filter
string [ 1 .. 64 ] characters
Example: filter=example text

Filter for searching by text fields - only those folders that contain a substring from the filter are returned:

  • in folder name
  • in folder comment
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (filesystem_column_type)
Default: "NAME"
Enum: "NAME" "OWNER_COMPANY_KEY" "OWNER_USERNAME" … 4 more
Example: sort_field=CREATION_DATE

The name of the column in the table with folders.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Responses

Response Schema: application/json
required
object (folder)

Folder is an element of a virtual file system.

required
Array of objects (folder) [ 0 .. 2001 ] items

List of folders.

required
object (table_list_counters)

Counters by list.

Response samples

Content type
application/json
{
}

Update folder

Rename and move folder.

Authorizations:
ApiKeyAuth
path Parameters
target_folder_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Request Body schema: application/json
required

Folder update request.

parent_key
string or null <uuid> (folder_parent_key)
Example: "11111111-2222-3333-4444-555555555555"

Parent folder key, null if the folder is root.

name
required
string (folder_name) [ 1 .. 100 ] characters
Example: "folder_1"

Folder name.

comment
string or null (folder_comment) [ 0 .. 10000 ] characters
Example: "long long long long text"

Folder comment.

color
string or null (folder_color) [ 1 .. 20 ] characters
Example: "red"

Folder color.

expiration_date
string or null <date-time> (folder_expiration_date)
Example: "2026-04-21T19:45:00Z"

Date and time of automatic deletion in the ISO 8601 format. Null means that automatic deletion does not occur.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (folder)

Folder is an element of a virtual file system.

required
Array of objects (folder) [ 0 .. 2001 ] items

List of folders.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Folder removal

Folder removal by key.

Authorizations:
ApiKeyAuth
path Parameters
target_folder_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Folder specification

Getting a folder specification.

Authorizations:
ApiKeyAuth
path Parameters
target_folder_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response Schema: application/json
parent_key
string or null <uuid> (folder_parent_key)
Example: "11111111-2222-3333-4444-555555555555"

Parent folder key, null if the folder is root.

name
required
string (folder_name) [ 1 .. 100 ] characters
Example: "folder_1"

Folder name.

comment
string or null (folder_comment) [ 0 .. 10000 ] characters
Example: "long long long long text"

Folder comment.

color
string or null (folder_color) [ 1 .. 20 ] characters
Example: "red"

Folder color.

expiration_date
string or null <date-time> (folder_expiration_date)
Example: "2026-04-21T19:45:00Z"

Date and time of automatic deletion in the ISO 8601 format. Null means that automatic deletion does not occur.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Response samples

Content type
application/json
{
}

Folder path

Folder path.

Authorizations:
ApiKeyAuth
path Parameters
target_folder_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response Schema: application/json
required
Array of objects (folder) [ 0 .. 1000 ] items

List of folders.

Response samples

Content type
application/json
{
}

Create folders (batch)

Create new folder (batch).

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Request to create a group of folders from the root of the virtual file system.

If any folder in the path already exists - it will not be created again.

The method returns the key of the last folder, even if no folders were created.

Array ([ 0 .. 10 ] items)
string (folder_name) [ 1 .. 100 ] characters

Folder name.

Responses

Response Schema: application/json
string <uuid> (unique_key)

Last folder key.

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

Folders removal (batch)

Batch delete folders.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

List of folder keys that need to be deleted.

Array ([ 0 .. 15001 ] items)
string <uuid> (unique_key)

Key, unique identifier.

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
}

Folder key

Getting a folder key by path.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Request to get a folder key by path from the root of the virtual filesystem. If any folder in the path not exists - 404 will be returned.

Array ([ 0 .. 10 ] items)
string (folder_name) [ 1 .. 100 ] characters

Folder name.

Responses

Response Schema: application/json
string <uuid> (unique_key)

Last folder key.

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

File key

Getting a file key by path.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Request to get a folder key by path from the root of the virtual filesystem. If in the folder multiple files with the same name - the last modified will be returned. If any folder or file in the path not exists - 404 will be returned.

folder_names
required
Array of strings (folder_name_list) [ 0 .. 10 ] items [ items [ 1 .. 100 ] characters ]
Example: ["folder_1"]

List of folder names from the root of the virtual filesystem.

file_name
required
string (file_name) [ 1 .. 100 ] characters
Example: "file_1"

File name.

Responses

Response Schema: application/json
string <uuid> (unique_key)

File key.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

Files removal (batch)

Batch delete files.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

List of file's keys that need to be deleted.

Array ([ 0 .. 15001 ] items)
string <uuid> (unique_key)

Key, unique identifier.

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
}

Filesystem counters

Getting a virtual filesystem counters.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
required
object (folder_counters)

Current number of available folders/files.

required
object (folder_counters)

Max number of available folders/files.

Response samples

Content type
application/json
{
}

Backups

Bulk data export and import.

Folder export

Export folder with experiments.

Authorizations:
ApiKeyAuth
path Parameters
target_folder_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Responses

Response Schema: application/octet-stream
string <byte> (file_zip)

ZIP archive with data.

Response samples

Content type
application/json
{
}

Folder import

Import folder with experiments. The folder should not be of type ROOT and should be empty.

Authorizations:
ApiKeyAuth
path Parameters
target_folder_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

Request Body schema: application/octet-stream
required

Data (ZIP).

string <byte> (file_zip)

ZIP archive with data.

Responses

Response samples

Content type
application/json
{
}

Crews

Crews management.

Crew creation

New crew creation.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Crew creation request.

key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: "mega_crew"

Unique crew key.

password
string or null <password> (user_password) [ 10 .. 256 ] characters
Example: "long_strong_password"

New password.

object (crew_composition)

Crew composition.

Responses

Response Schema: application/json
key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: "mega_crew"

Unique crew key.

account_username
required
string (user_username) [ 2 .. 256 ] characters \w+
Example: "username_for_login"

The username of the account that uses the crew.

owner_company_key
required
string (company_key) [ 3 .. 256 ] characters \w+
Example: "smart_company"

The key of the company that owns the crew.

owner_username
required
string (user_username) [ 2 .. 256 ] characters \w+
Example: "username_for_login"

The username of the account that owns the crew.

required
object (crew_status)

Crew status.

object (crew_composition)

Crew composition.

Array of objects (crew_device_list) [ 0 .. 100 ] items

List of device.

edit_date
required
string <date-time>
Example: "2026-04-21T19:45:00Z"

Last edit date and time in the ISO 8601 format.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Crew update

Updating the crew information.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Crew update request.

key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: "mega_crew"

Unique crew key.

password
string or null <password> (user_password) [ 10 .. 256 ] characters
Example: "long_strong_password"

New password.

object (crew_composition)

Crew composition.

Responses

Response Schema: application/json
key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: "mega_crew"

Unique crew key.

account_username
required
string (user_username) [ 2 .. 256 ] characters \w+
Example: "username_for_login"

The username of the account that uses the crew.

owner_company_key
required
string (company_key) [ 3 .. 256 ] characters \w+
Example: "smart_company"

The key of the company that owns the crew.

owner_username
required
string (user_username) [ 2 .. 256 ] characters \w+
Example: "username_for_login"

The username of the account that owns the crew.

required
object (crew_status)

Crew status.

object (crew_composition)

Crew composition.

Array of objects (crew_device_list) [ 0 .. 100 ] items

List of device.

edit_date
required
string <date-time>
Example: "2026-04-21T19:45:00Z"

Last edit date and time in the ISO 8601 format.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Getting crew information

Getting crew information by key.

Authorizations:
ApiKeyAuth
path Parameters
crew_key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: mega_crew

Parameter (path) with crew key.

Responses

Response Schema: application/json
required
object (crew)

Crew.

object (table_crew_fields)

Crew fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Response samples

Content type
application/json
{
}

Crew removal

Removing a crew by key.

Authorizations:
ApiKeyAuth
path Parameters
crew_key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: mega_crew

Parameter (path) with crew key.

Responses

Response samples

Content type
application/json
{
}

Reading crews (table)

Getting a list of crews.

Authorizations:
ApiKeyAuth
query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_crew_column_type)
Default: "ESSENCE_KEY"
Enum: "ESSENCE_KEY" "ACCOUNT_USERNAME" "OWNER_USERNAME" … 3 more
Example: sort_field=OWNER_COMPANY_KEY

Crew table column name.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Crews filter.

Array of objects (table_crew_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_crew) [ 0 .. 2001 ] items

A list.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Crews removal (batch)

Batch crews delete.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Request to delete crews.

Array ([ 0 .. 2001 ] items)
string (crew_key) [ 3 .. 256 ] characters \w+

Unique crew key.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Crew geopoints

Getting a crew geopoints.

Authorizations:
ApiKeyAuth
query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

Request Body schema: application/json
optional

Crews filter.

Array of objects (table_crew_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (crew_geopoint) [ 0 .. 2001 ] items

A list of points.

required
object (table_list_counters)

Counters by list of entities.

required
object (table_list_counters_detail)

Counters by list of points.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Import crews (JSON)

Importing new data from JSON file. If the entity is already present (determined by its key), it is updated. If not, a new one is created.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Data (JSON).

Array ([ 0 .. 15001 ] items)
key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: "mega_crew"

Unique crew key.

password
string or null <password> (user_password) [ 10 .. 256 ] characters
Example: "long_strong_password"

New password.

object (crew_composition)

Crew composition.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Import crews (XLSX)

Importing new data from XLSX file. If the entity is already present (determined by its key), it is updated. If not, a new one is created.

Authorizations:
ApiKeyAuth
Request Body schema: application/octet-stream
required

Data (XLSX).

string <byte> (file_xlsx)

File with data in XLSX format.

Responses

Response samples

Content type
application/json
{
}

Export crews (JSON)

Exporting crews to a JSON file.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
Array ([ 0 .. 15001 ] items)
key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: "mega_crew"

Unique crew key.

object (crew_composition)

Crew composition.

Response samples

Content type
application/json
[
]

Export crews (XLSX)

Exporting crews to a XLSX file.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/octet-stream
string <byte> (file_xlsx)

File with data in XLSX format.

Response samples

Content type
application/json
{
}

Self crew information APP

Getting crew information by login.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: "mega_crew"

Unique crew key.

account_username
required
string (user_username) [ 2 .. 256 ] characters \w+
Example: "username_for_login"

The username of the account that uses the crew.

owner_company_key
required
string (company_key) [ 3 .. 256 ] characters \w+
Example: "smart_company"

The key of the company that owns the crew.

owner_username
required
string (user_username) [ 2 .. 256 ] characters \w+
Example: "username_for_login"

The username of the account that owns the crew.

required
object (crew_status)

Crew status.

object (crew_composition)

Crew composition.

Array of objects (crew_device_list) [ 0 .. 100 ] items

List of device.

edit_date
required
string <date-time>
Example: "2026-04-21T19:45:00Z"

Last edit date and time in the ISO 8601 format.

Response samples

Content type
application/json
{
}

Device update APP

Updating information about your device (by login).

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Request to update information about your device.

key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: "key01"

Unique device identifier.

app_version
string or null [ 2 .. 64 ] characters
Default: null
Example: "7.51"

Application version.

os_version
string or null [ 2 .. 64 ] characters
Default: null
Example: "15.0"

Operation system version.

manufacturer
string or null [ 2 .. 64 ] characters
Default: null
Example: "Samsung"

Mobile device manufacturer.

model
string or null [ 2 .. 64 ] characters
Default: null
Example: "S25"

Mobile device model.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Deals

Deals management.

Deal - the assignment of a team to a specific trip from a specific wave.

Deal creation

New deal creation.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Deal creation request.

crew_key
required
string (crew_key) [ 3 .. 256 ] characters \w+
Example: "mega_crew"

Unique crew key.

wave_key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

trip_key
required
string [ 1 .. 1024 ] characters
Example: "trip-0000-9999"

Unique trip identifier.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Unique deal identifier.

required
object (deal_specification)

Deal description.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Deal update

Updating the deal information.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Deal update request.

key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Unique deal identifier.

required
object (deal_specification)

Deal description.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Unique deal identifier.

required
object (deal_specification)

Deal description.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Getting deal information

Getting deal information by key.

Authorizations:
ApiKeyAuth
path Parameters
deal_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Unique deal identifier.

required
object (deal_specification)

Deal description.

Response samples

Content type
application/json
{
}

Deal removal

Removing a deal by key.

Authorizations:
ApiKeyAuth
path Parameters
deal_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

Key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Deals removal (batch)

Batch deals delete.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

Request to delete deals.

Array ([ 0 .. 15001 ] items)
string <uuid> (unique_key)

Key, unique identifier.

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
}

Self crew trips APP

Getting a crew trips by login.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
Array ([ 0 .. 30 ] items)
required
object (deal)

Deal - the assignment of a team to a specific trip from a specific wave.

trip (object) or nullable (null)
Default: null

Trip.

trip_status (string) or nullable (null)
Default: null

Status.

trip_statistics (object) or nullable (null)
Default: null

Statistics.

Response samples

Content type
application/json
[
]

Waves

Waves management.

Create wave

Create new wave.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

wave create request.

name
required
string (file_name) [ 1 .. 100 ] characters
Example: "file_1"

File name.

comment
required
string or null (file_comment) [ 0 .. 10000 ] characters
Example: "long long long long text"

File comment.

folder_key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

The key of the folder of type FOLDER in which the file is located.

Responses

Response Schema: application/json
string <uuid> (unique_key)

New wave key.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

Reading wave

Getting wave information by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-04-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-04-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Response samples

Content type
application/json
{
}

Wave update

Rename \ move wave.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

wave specification update request.

name
required
string (file_name) [ 1 .. 100 ] characters
Example: "file_1"

File name.

comment
required
string or null (file_comment) [ 0 .. 10000 ] characters
Example: "long long long long text"

File comment.

folder_key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

The key of the folder of type FOLDER in which the file is located.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-04-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-04-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Wave removal

Wave removal by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Waves list (table)

Getting a table with wave.

Authorizations:
ApiKeyAuth
query Parameters
folder_key
string <uuid> (unique_key)
Example: folder_key=11111111-2222-3333-4444-555555555555

Folder key, unique identifier.

filter
string [ 1 .. 64 ] characters
Example: filter=example text

Filter for searching by text fields - only those files are returned whose name or description contains a substring from the filter. If the filter is empty, all files in the folder are returned. The results are sorted by editing time.

offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_wave_column_type)
Default: "SPECIFICATION_NAME"
Enum: "ESSENCE_KEY" "CREATION_DATE" "EDIT_DATE" … 3 more
Example: sort_field=SPECIFICATION_FOLDER_KEY

Wave table column name.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Responses

Response Schema: application/json
required
Array of objects (wave) [ 0 .. 2001 ] items

A list of waves.

required
object (table_list_counters)

Counters by list.

Response samples

Content type
application/json
{
}

Wave search

Wave global search.

Authorizations:
ApiKeyAuth
query Parameters
filter
required
string [ 3 .. 128 ] characters
Example: filter=example text

Filter for searching by text fields - only those configurations are returned whose name or description contains a substring from the filter. If the filter is empty, an empty list is returned. By default the results are sorted by editing time.

offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_wave_column_type)
Default: "SPECIFICATION_NAME"
Enum: "ESSENCE_KEY" "CREATION_DATE" "EDIT_DATE" … 3 more
Example: sort_field=SPECIFICATION_FOLDER_KEY

Wave table column name.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Responses

Response Schema: application/json
required
Array of objects (wave) [ 0 .. 2001 ] items

A list of waves.

required
object (table_list_counters)

Counters by list.

Response samples

Content type
application/json
{
}

Wave duplicate

Wave duplicate.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

wave duplicate request.

name
required
string (file_name) [ 1 .. 100 ] characters
Example: "file_1"

File name.

comment
required
string or null (file_comment) [ 0 .. 10000 ] characters
Example: "long long long long text"

File comment.

folder_key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

The key of the folder of type FOLDER in which the file is located.

Responses

Response Schema: application/json
string <uuid> (unique_key)

Duplicated wave key.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
"11111111-2222-3333-4444-555555555555"

Wave path

Wave path.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json
required
Array of objects (folder) [ 0 .. 1000 ] items

List of folders.

Response samples

Content type
application/json
{
}

Import (XLSX)

Importing new data from an XLSX file. If an entity is already present (determined by its key), it is updated. If not, a new one is created. The data time zone is taken from the XLSX file.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/octet-stream
required

Data (XLSX).

string <byte> (file_xlsx)

File with data in XLSX format.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-04-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-04-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Response samples

Content type
application/json
{
}

Import (JSON)

Importing new data from VRt.Universal JSON file. If the entity is already present (determined by its key), it is updated. If not, a new one is created.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data (JSON).

Array of objects (location_list) [ 0 .. 15001 ] items unique

List of locations used for orders and shifts.

Array of objects (order_list) [ 0 .. 15001 ] items unique

List of orders that need to be completed.

Array of objects (performer_list) [ 0 .. 15001 ] items unique

Available performers list. The performer fulfills orders using transport.

Array of objects (transport_list) [ 0 .. 15001 ] items unique

Available transports list. Transport is used by the trip performer to fulfill orders.

Array of objects (hardlink_list) [ 0 .. 15001 ] items unique

Assignments list.

Array of objects (trip_list) [ 0 .. 15001 ] items unique

Trip list. 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.

Array of objects (fact_list) [ 0 .. 15001 ] items unique

Trip list. A fact is an event that has occurred that affects further trip operations.

plan_statistics (object) or nullable (null)
Default: null

General statistics on the calculation result.

Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique

List of matrices of times and distances for each type of transport that are indicated in the data. The matrix should describe all locations for each type of transport from the data. When specifying an external routing matrix external_routing, the plan_settings.geo_settings parameters are not taken into account.

object (plan_settings)

Planning settings.

object (replan_settings)

Replanning settings.

object (actualize_settings)

Actualize settings.

dataset_name
string (dataset_name) [ 0 .. 512 ] characters
Example: "custom_dataset_one"

The name of the dataset. A technical field that does not affect calculation.

Responses

Response Schema: application/json
key
required
string <uuid> (unique_key)
Example: "11111111-2222-3333-4444-555555555555"

Key, unique identifier.

required
object (file_specification)

File specification.

required
object (experiment_settings)

Experiment settings.

required
object (experiment_statistics)

Experiment statistics.

calculation_state (object) or nullable (null)
Default: null

Current calculation state if possible.

experiment_check (object) or nullable (null)
Default: null

Result of checking the dataset.

edit_date
required
string <date-time> (file_edit_date)
Example: "2026-04-21T19:45:00Z"

Last file edit date and time in the ISO 8601 format.

creation_date
required
string <date-time> (file_creation_date)
Example: "2026-04-21T19:45:00Z"

File creation date and time in the ISO 8601 format.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Export (XLSX)

Export (XLSX).

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
timezone
integer <int32> (timezone) [ -12 .. 12 ]
Default: 0
Example: timezone=3

Target time zone.

Responses

Response Schema: application/octet-stream
string <byte> (file_xlsx)

File with data in XLSX format.

Response samples

Content type
application/json
{
}

Export (JSON)

Export data to VRt.Universal JSON file.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response Schema: application/json
Array of objects (location_list) [ 0 .. 15001 ] items unique

List of locations used for orders and shifts.

Array of objects (order_list) [ 0 .. 15001 ] items unique

List of orders that need to be completed.

Array of objects (performer_list) [ 0 .. 15001 ] items unique

Available performers list. The performer fulfills orders using transport.

Array of objects (transport_list) [ 0 .. 15001 ] items unique

Available transports list. Transport is used by the trip performer to fulfill orders.

Array of objects (hardlink_list) [ 0 .. 15001 ] items unique

Assignments list.

Array of objects (trip_list) [ 0 .. 15001 ] items unique

Trip list. 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.

Array of objects (fact_list) [ 0 .. 15001 ] items unique

Trip list. A fact is an event that has occurred that affects further trip operations.

plan_statistics (object) or nullable (null)
Default: null

General statistics on the calculation result.

Array of objects (routing_transport_matrix_list) [ 0 .. 16 ] items unique

List of matrices of times and distances for each type of transport that are indicated in the data. The matrix should describe all locations for each type of transport from the data. When specifying an external routing matrix external_routing, the plan_settings.geo_settings parameters are not taken into account.

object (plan_settings)

Planning settings.

object (replan_settings)

Replanning settings.

object (actualize_settings)

Actualize settings.

dataset_name
string (dataset_name) [ 0 .. 512 ] characters
Example: "custom_dataset_one"

The name of the dataset. A technical field that does not affect calculation.

Response samples

Content type
application/json
{
}

Locations

Locations management.

Create location

Create location.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

key
required
string [ 1 .. 1024 ] characters
Example: "location_01"

Location key, unique identifier.

required
object (geopoint)

Geographical point.

arrival_duration
string <duration> (time_duration) [ 3 .. 16 ] characters ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d...
Example: "PT1H45M"

Time for driving up to the location (or waiting time at parking lot) according to ISO 8601 duration.

departure_duration
string <duration> (time_duration) [ 3 .. 16 ] characters ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d...
Example: "PT1H45M"

Time to leave the location according to ISO 8601 duration.

Array of objects (location_timetable) [ 0 .. 30 ] items

Location timetable - time windows of availability and capacity restrictions. If the list is empty or not specified, the location works without restrictions.

location_compatibilities (object) or nullable (null)
Default: null

Location compatibilities.

name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

address
string or null [ 1 .. 1024 ] characters
Default: null
Example: "24th Line V.O., 15/2, building A, St. Petersburg, 199106"

Full location address.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (location)

Location - unique geographical location of the object with accessibility parameters.

location_statistics (object) or nullable (null)
Default: null

Statistics for a specific trip.

object (table_location_fields)

Location fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update location

Updating the location by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Essence update request.

key
required
string [ 1 .. 1024 ] characters
Example: "location_01"

Location key, unique identifier.

required
object (geopoint)

Geographical point.

arrival_duration
string <duration> (time_duration) [ 3 .. 16 ] characters ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d...
Example: "PT1H45M"

Time for driving up to the location (or waiting time at parking lot) according to ISO 8601 duration.

departure_duration
string <duration> (time_duration) [ 3 .. 16 ] characters ^P(?!$)((\d+Y)|(\d+\.\d+Y$))?((\d+M)|(\d+\.\d...
Example: "PT1H45M"

Time to leave the location according to ISO 8601 duration.

Array of objects (location_timetable) [ 0 .. 30 ] items

Location timetable - time windows of availability and capacity restrictions. If the list is empty or not specified, the location works without restrictions.

location_compatibilities (object) or nullable (null)
Default: null

Location compatibilities.

name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

address
string or null [ 1 .. 1024 ] characters
Default: null
Example: "24th Line V.O., 15/2, building A, St. Petersburg, 199106"

Full location address.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (location)

Location - unique geographical location of the object with accessibility parameters.

location_statistics (object) or nullable (null)
Default: null

Statistics for a specific trip.

object (table_location_fields)

Location fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Read location

Getting location information by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response Schema: application/json
required
object (location)

Location - unique geographical location of the object with accessibility parameters.

location_statistics (object) or nullable (null)
Default: null

Statistics for a specific trip.

object (table_location_fields)

Location fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Response samples

Content type
application/json
{
}

Remove location

Removing a location by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Locations list

Getting a locations list.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_location_column_type)
Default: "NAME"
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 4 more
Example: sort_field=ESSENCE_KEY

Locations table column name.

sort_customfield
string (table_customfields_column_type)
Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more
Example: sort_customfield=STRING_1

The name of the additional column in the table.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Locations filter.

Array of objects (table_location_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_location) [ 0 .. 2001 ] items

Locations list.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete locations (batch)

Removing locations from the file.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to delete locations.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Location geopoints

Getting a geopoints.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

Request Body schema: application/json
optional

Locations filter.

Array of objects (table_location_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (web_location_geopoint) [ 0 .. 2001 ] items

A list of points.

required
object (table_list_counters)

Counters by list of entities.

required
object (table_list_counters_detail)

Counters by list of points.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Location metrics

Calculate general metrics for selected locations.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data for calculating metrics. If entity keys are specified, metrics are calculated by them. If keys are not specified, metrics are calculated by all entities that fall under the filters.

keys
Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ]
Example: ["key01"]

A list of keys.

Array of objects (table_location_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
object (table_location_fields)

Total values for fields of types int, double, duration.

object (table_location_fields)

Average values for fields of types int, double, duration. Only fields that have a value are taken into account to calculate the average.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Orders

Orders management.

Create order

New order creation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

key
required
string [ 1 .. 1024 ] characters
Example: "order01"

Order key, unique identifier.

required
Array of objects (demand) [ 1 .. 1000 ] items unique

Demands list.

Array of objects (cargo_list) [ 0 .. 1000 ] items unique

The list of cargoes referred to by the demands of this order. The list must be empty if all demands in the order are of type WORK.

order_compatibilities (object) or nullable (null)
Default: null
name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (order)

The order for delivery/transportation, contains a list of demands.

object (table_order_fields)

Order and demand fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update order

Updating the essence by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Essence update request.

key
required
string [ 1 .. 1024 ] characters
Example: "order01"

Order key, unique identifier.

required
Array of objects (demand) [ 1 .. 1000 ] items unique

Demands list.

Array of objects (cargo_list) [ 0 .. 1000 ] items unique

The list of cargoes referred to by the demands of this order. The list must be empty if all demands in the order are of type WORK.

order_compatibilities (object) or nullable (null)
Default: null
name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (order)

The order for delivery/transportation, contains a list of demands.

object (table_order_fields)

Order and demand fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reading order

Getting order information by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response Schema: application/json
required
object (order)

The order for delivery/transportation, contains a list of demands.

object (table_order_fields)

Order and demand fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Response samples

Content type
application/json
{
}

Deleting one order

Removing a essence by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

List orders

Getting a orders list.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_order_column_type)
Default: "NAME"
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 30 more
Example: sort_field=ESSENCE_KEY

Order table column name.

sort_customfield
string (table_customfields_column_type)
Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more
Example: sort_customfield=STRING_1

The name of the additional column in the table.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Essence filter.

Array of objects (table_order_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_order) [ 0 .. 15001 ] items

Orders list.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete orders (batch)

Removing orders from the file.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to delete orders.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Enable orders

Enable orders in the calculation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Enable orders request.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Disable orders

Disable orders in the calculation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Disable orders request.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Order geopoints

Getting a geopoints.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

Request Body schema: application/json
optional

Orders filter.

Array of objects (table_order_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (web_order_geopoint) [ 0 .. 2001 ] items

A list of points.

required
object (table_list_counters)

Counters by list of entities.

required
object (table_list_counters_detail)

Counters by list of points.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Order metrics

Calculate general metrics for selected orders.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data for calculating metrics. If entity keys are specified, metrics are calculated by them. If keys are not specified, metrics are calculated by all entities that fall under the filters.

keys
Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ]
Example: ["key01"]

A list of keys.

Array of objects (table_order_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
object (table_order_fields)

Total values for fields of types int, double, duration.

object (table_order_fields)

Average values for fields of types int, double, duration. Only fields that have a value are taken into account to calculate the average.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Performers

Performers management.

Create performer

Create performer.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

key
required
string [ 1 .. 1024 ] characters
Example: "performer0001"

Performer's key, unique identifier.

required
Array of objects (performer_shift) [ 1 .. 15001 ] items unique

List of working shifts of performer.

own_transport_type
string (transport_type)
Default: "CAR"
Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more
Example: "CAR"

The type of personal transport that the performer will use to get to his assigned work transport.

performer_compatibilities (object) or nullable (null)
Default: null

Performer compatibilities.

performer_limits (object) or nullable (null)
Default: null

Limitation on the performer's workload.

name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (performer)

Performer. Fulfills orders using transport.

object (table_performer_fields)

Performer and shift fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update performer

Updating the performer by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Essence update request.

key
required
string [ 1 .. 1024 ] characters
Example: "performer0001"

Performer's key, unique identifier.

required
Array of objects (performer_shift) [ 1 .. 15001 ] items unique

List of working shifts of performer.

own_transport_type
string (transport_type)
Default: "CAR"
Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more
Example: "CAR"

The type of personal transport that the performer will use to get to his assigned work transport.

performer_compatibilities (object) or nullable (null)
Default: null

Performer compatibilities.

performer_limits (object) or nullable (null)
Default: null

Limitation on the performer's workload.

name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (performer)

Performer. Fulfills orders using transport.

object (table_performer_fields)

Performer and shift fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Read performer

Getting performer information by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response Schema: application/json
required
object (performer)

Performer. Fulfills orders using transport.

object (table_performer_fields)

Performer and shift fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Response samples

Content type
application/json
{
}

Remove performer

Removing a performer by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Performers list

Getting a performers list.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_performer_column_type)
Default: "NAME"
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 12 more
Example: sort_field=ESSENCE_KEY

Performers table column name.

sort_customfield
string (table_customfields_column_type)
Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more
Example: sort_customfield=STRING_1

The name of the additional column in the table.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Performers filter.

Array of objects (table_performer_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_performer) [ 0 .. 2001 ] items

Performers list.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete performers (batch)

Removing performers from the file.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to delete performers.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Enable performers

Enable performers in the calculation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Enable performers request.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Disable performers

Disable performers in the calculation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Disable performers request.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Performer geopoints

Getting a geopoints.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

Request Body schema: application/json
optional

Performers filter.

Array of objects (table_performer_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (web_performer_geopoint) [ 0 .. 2001 ] items

A list of points.

required
object (table_list_counters)

Counters by list of entities.

required
object (table_list_counters_detail)

Counters by list of points.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Performer metrics

Calculate general metrics for selected performers.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data for calculating metrics. If entity keys are specified, metrics are calculated by them. If keys are not specified, metrics are calculated by all entities that fall under the filters.

keys
Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ]
Example: ["key01"]

A list of keys.

Array of objects (table_performer_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
object (table_performer_fields)

Total values for fields of types int, double, duration.

object (table_performer_fields)

Average values for fields of types int, double, duration. Only fields that have a value are taken into account to calculate the average.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Transports

Transports management.

Create transport

New essences creation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

key
required
string [ 1 .. 1024 ] characters
Example: "transport001"

Transport key, unique identifier.

required
Array of objects (transport_shift) [ 1 .. 15001 ] items unique

List of working shifts of transport.

transport_type
string (transport_type)
Default: "CAR"
Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more
Example: "CAR"

Transport types:

  • CAR - car
  • TRUCK_1500 - truck with permissible weight 1500 kg
  • TRUCK_3000 - truck with permissible weight 3000 kg
  • TRUCK_5000 - truck with permissible weight 5000 kg
  • TRUCK_10000 - truck with permissible weight 10000 kg
  • TRUCK_20000 - truck with permissible weight 20000 kg
  • TRUCK_10000_L75_H35_W24_6000 - a truck with a permitted weight of no more than 10,000 kg, dimensions of 7.5 x 3.5 x 2.4 meters, and a permissible axle load of 6,000 kg
  • TRUCK_18000_L95_H40_W26_11000 - a truck with a permitted weight of no more than 18,000 kg, dimensions of 9.5 x 4.0 x 2.6 meters, and a permissible axle load of 11,000 kg
  • TRUCK_26000_L120_H40_W26_8000 - a truck with a permitted weight of no more than 26,000 kg, dimensions of 12.0 x 4.0 x 2.6 meters, and a permissible axle load of 8000 kg
  • TRUCK_GARBAGE_1 - truck for transporting garbage (type 1)
  • TRUCK_GARBAGE_2 - truck for transporting garbage (type 2)
  • TUK_TUK - tuk-tuk
  • BICYCLE - bicycle
  • PEDESTRIAN - pedestrian
  • PUBLIC_TRANSPORT - public transport
  • TELEPORT - teleport (instant movement between points)

Permissible weight is the weight of the equipped transport with cargo and driver, set by the manufacturer as the maximum allowable.

Array of objects (box) [ 0 .. 100 ] items
Default: []

A list of transport boxes that can accommodate the cargo.

transport_compatibilities (object) or nullable (null)
Default: null

Transport compatibilities.

transport_limits (object) or nullable (null)
Default: null

Transport load limits.

name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

object (table_transport_fields)

Transport and shift fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update transport

Updating the essence by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Essence update request.

key
required
string [ 1 .. 1024 ] characters
Example: "transport001"

Transport key, unique identifier.

required
Array of objects (transport_shift) [ 1 .. 15001 ] items unique

List of working shifts of transport.

transport_type
string (transport_type)
Default: "CAR"
Enum: "CAR" "TRUCK_1500" "TRUCK_3000" … 13 more
Example: "CAR"

Transport types:

  • CAR - car
  • TRUCK_1500 - truck with permissible weight 1500 kg
  • TRUCK_3000 - truck with permissible weight 3000 kg
  • TRUCK_5000 - truck with permissible weight 5000 kg
  • TRUCK_10000 - truck with permissible weight 10000 kg
  • TRUCK_20000 - truck with permissible weight 20000 kg
  • TRUCK_10000_L75_H35_W24_6000 - a truck with a permitted weight of no more than 10,000 kg, dimensions of 7.5 x 3.5 x 2.4 meters, and a permissible axle load of 6,000 kg
  • TRUCK_18000_L95_H40_W26_11000 - a truck with a permitted weight of no more than 18,000 kg, dimensions of 9.5 x 4.0 x 2.6 meters, and a permissible axle load of 11,000 kg
  • TRUCK_26000_L120_H40_W26_8000 - a truck with a permitted weight of no more than 26,000 kg, dimensions of 12.0 x 4.0 x 2.6 meters, and a permissible axle load of 8000 kg
  • TRUCK_GARBAGE_1 - truck for transporting garbage (type 1)
  • TRUCK_GARBAGE_2 - truck for transporting garbage (type 2)
  • TUK_TUK - tuk-tuk
  • BICYCLE - bicycle
  • PEDESTRIAN - pedestrian
  • PUBLIC_TRANSPORT - public transport
  • TELEPORT - teleport (instant movement between points)

Permissible weight is the weight of the equipped transport with cargo and driver, set by the manufacturer as the maximum allowable.

Array of objects (box) [ 0 .. 100 ] items
Default: []

A list of transport boxes that can accommodate the cargo.

transport_compatibilities (object) or nullable (null)
Default: null

Transport compatibilities.

transport_limits (object) or nullable (null)
Default: null

Transport load limits.

name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

object (table_transport_fields)

Transport and shift fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reading transport

Getting transport information by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response Schema: application/json
required
object (transport)

Transport. Used by performer for relocating and cargo transfer.

object (table_transport_fields)

Transport and shift fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Response samples

Content type
application/json
{
}

Remove transport

Removing a transport by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Transport list

Getting a transport list.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_transport_column_type)
Default: "NAME"
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 18 more
Example: sort_field=ESSENCE_KEY

Transport table column name.

sort_customfield
string (table_customfields_column_type)
Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more
Example: sort_customfield=STRING_1

The name of the additional column in the table.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Transport filter.

Array of objects (table_transport_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_transport) [ 0 .. 2001 ] items

Transports list.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete transports (batch)

Removing transports from the file.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to delete transports.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Enable transports

Enable transports in the calculation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Enable transports request.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Disable transports

Disable transports in the calculation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Disable transports request.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Transport geopoints

Getting a geopoints.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

Request Body schema: application/json
optional

Transports filter.

Array of objects (table_transport_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (web_transport_geopoint) [ 0 .. 2001 ] items

A list of points.

required
object (table_list_counters)

Counters by list of entities.

required
object (table_list_counters_detail)

Counters by list of points.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Transport metrics

Calculate general metrics for selected transports.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data for calculating metrics. If entity keys are specified, metrics are calculated by them. If keys are not specified, metrics are calculated by all entities that fall under the filters.

keys
Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ]
Example: ["key01"]

A list of keys.

Array of objects (table_transport_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
object (table_transport_fields)

Total values for fields of types int, double, duration.

object (table_transport_fields)

Average values for fields of types int, double, duration. Only fields that have a value are taken into account to calculate the average.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Trips

Trips management.

Trip create

New essences creation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

key
required
string [ 1 .. 1024 ] characters
Example: "trip-0000-9999"

Unique trip identifier.

required
object (assigned_performer)

Performer's shift assigned to the specified time (shift_time).

required
object (assigned_transport)

Transport's shift assigned to the specified time (shift_time).

required
Array of objects (trip_state_list) [ 0 .. 15001 ] items

List of performer's states.

waitlist
Array of strings (trip_waitlist) [ 0 .. 15001 ] items unique [ items [ 1 .. 1024 ] characters ]
Example: ["order02"]

List of order keys assigned to the performer, but not scheduled for a specific time and not taken into account in the transport load.

name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

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.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Trip update

Updating the essence by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Essence update request.

key
required
string [ 1 .. 1024 ] characters
Example: "trip-0000-9999"

Unique trip identifier.

required
object (assigned_performer)

Performer's shift assigned to the specified time (shift_time).

required
object (assigned_transport)

Transport's shift assigned to the specified time (shift_time).

required
Array of objects (trip_state_list) [ 0 .. 15001 ] items

List of performer's states.

waitlist
Array of strings (trip_waitlist) [ 0 .. 15001 ] items unique [ items [ 1 .. 1024 ] characters ]
Example: ["order02"]

List of order keys assigned to the performer, but not scheduled for a specific time and not taken into account in the transport load.

name
string (name) [ 0 .. 128 ] characters
Example: "X1-ABC"

Name, information field.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

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.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Read trip

Getting trip information by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
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
{
}

Delete trip

Removing a trip by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Reading trips (table)

Getting a trips list.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_trip_column_type)
Default: "TRIP_NAME"
Enum: "ESSENCE_KEY" "ENABLED" "TRIP_VERIFIED" … 34 more
Example: sort_field=DISTANCE

Trip table column name.

sort_customfield
string (table_customfields_column_type)
Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more
Example: sort_customfield=STRING_1

The name of the additional column in the table.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Trip filter.

Array of objects (table_trip_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_trip) [ 0 .. 2001 ] items

List of trips or roundtrips.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete trips (batch)

Removing trips from the wave.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to delete trips.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Trips chart

Getting a trips for chart.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_trip_column_type)
Default: "TRIP_NAME"
Enum: "ESSENCE_KEY" "ENABLED" "TRIP_VERIFIED" … 34 more
Example: sort_field=DISTANCE

Trip table column name.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Trips filter.

Array of objects (table_trip_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (web_trip_chart) [ 0 .. 2001 ] items

Data for chart.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Trip tracks

Getting a tracks.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

tracks_type
required
string (track_type)
Default: "LINE"
Enum: "LINE" "ROAD" "CUSTOM"
Example: ROAD

Tracks type:

  • LINE - connecting stop points in a straight line
  • ROAD - connecting stop points along roads
  • EXTERNAL - externally loaded custom tracks
query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

Request Body schema: application/json
optional

Trips filter.

Array of objects (table_trip_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (track) [ 0 .. 2001 ] items

A list of tracks.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Load custom tracks

Load custom tracks.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
optional

Custom tracks list.

required
Array of objects (track) [ 0 .. 15001 ] items

A list of tracks.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Remove custom tracks

Remove custom all tracks.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

Trips metrics

Calculate general metrics for selected trips.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data for calculating metrics. If entity keys are specified, metrics are calculated by them. If keys are not specified, metrics are calculated by all entities that fall under the filters.

keys
Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ]
Example: ["key01"]

A list of keys.

Array of objects (table_trip_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
object (table_trip_fields)

Total values for fields of types int, double, duration.

object (table_trip_fields)

Average values for fields of types int, double, duration. Only fields that have a value are taken into account to calculate the average.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Trip stops list

Getting a trip stops list.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_trip_stop_column_type)
Default: "ESSENCE_KEY"
Enum: "ESSENCE_KEY" "DRIVING_TIME" "WAITING_TIME" … 14 more
Example: sort_field=LOCATION_NAME

Trip stops table column name.

sort_customfield
string (table_customfields_column_type)
Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more
Example: sort_customfield=STRING_1

The name of the additional column in the table.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Trip stops filter.

Array of objects (table_trip_stop_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_trip_stop) [ 0 .. 2001 ] items

Trip stops list.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reading roundrips (table)

Getting a roundrips list.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_roundtrip_column_type)
Default: "TRIP_NAME"
Enum: "ESSENCE_KEY" "ENABLED" "TRIP_KEY" … 32 more
Example: sort_field=DISTANCE

Trip table column name.

sort_customfield
string (table_customfields_column_type)
Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more
Example: sort_customfield=STRING_1

The name of the additional column in the table.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Trip filter.

Array of objects (table_roundtrip_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_roundtrip) [ 0 .. 2001 ] items

List of roundtrips.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Roundrips metrics

Calculate general metrics for selected roundrips.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data for calculating metrics. If entity keys are specified, metrics are calculated by them. If keys are not specified, metrics are calculated by all entities that fall under the filters.

keys
Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ]
Example: ["key01"]

A list of keys.

Array of objects (table_roundtrip_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
object (table_roundtrip_fields)

Total values for fields of types int, double, duration.

object (table_roundtrip_fields)

Average values for fields of types int, double, duration. Only fields that have a value are taken into account to calculate the average.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Read available crews

Obtaining a list of crews that can perform the specified trip.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_crew_column_type)
Default: "ESSENCE_KEY"
Enum: "ESSENCE_KEY" "ACCOUNT_USERNAME" "OWNER_USERNAME" … 3 more
Example: sort_field=OWNER_COMPANY_KEY

Crew table column name.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Crews filter.

Array of objects (table_crew_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_crew) [ 0 .. 2001 ] items

A list.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Run trips (batch)

Run trips (batch). If the trip key list is empty, all trips from the wave are exec.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to exec trips.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
}

Stop trips (batch)

Stop trips (batch). If the trip key list is empty, all trips from the wave are stop.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to stop trips.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
}

Data from trip APP

Read trip data.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response Schema: application/json
required
Array of objects (location_list_required) [ 1 .. 15001 ] items unique

Locations.

required
Array of objects (order_list_required) [ 1 .. 15001 ] items unique

Orders.

Response samples

Content type
application/json
{
}

Facts from trip APP

Read facts from trip.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response Schema: application/json
Array ([ 0 .. 15000 ] items)
required
object (fact)

The fact about the order is the action taken with the order or its part (demand).

Response samples

Content type
application/json
[
]

Planned trip track APP

Read planned trip track.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response Schema: application/json
Array ([ 0 .. 1000000 ] items)
latitude
required
number <double> [ -90 .. 90 ]
Example: "55.692789"

Latitude in degrees.

longitude
required
number <double> [ -180 .. 180 ]
Example: "37.554554"

Longitude in degrees.

time
string or null <date-time>
Default: null
Example: "2026-04-21T09:30:00+03:00"

Date and time in the ISO 8601 format.

Response samples

Content type
application/json
[ ]

Historical track of the trip APP

Read historical track of the trip.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response Schema: application/json
Array ([ 0 .. 1000000 ] items)
latitude
required
number <double> [ -90 .. 90 ]
Example: "55.692789"

Latitude in degrees.

longitude
required
number <double> [ -180 .. 180 ]
Example: "37.554554"

Longitude in degrees.

time
string or null <date-time>
Default: null
Example: "2026-04-21T09:30:00+03:00"

Date and time in the ISO 8601 format.

Response samples

Content type
application/json
[ ]

Facts

Facts management.

Create fact

Creating a fact. You can only create a new fact with the 'NEW' status.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

New essence creation request.

key
required
string [ 1 .. 1024 ] characters
Example: "fact_01"

Fact key.

time
required
string <date-time> (fact_time)
Example: "2026-04-21T09:30:00+03:00"

Fact creation time in the ISO 8601 format.

type
required
string (fact_type)
Enum: "NEW_LOCATION" "ORDER_DONE" "DEMAND_START" … 6 more
Example: "NEW_LOCATION"

Possible fact types:

  • NEW_LOCATION - the performer changed his location during the trip
  • ORDER_DONE - the performer has finished fulfilling the order (or the order has been cancelled), the cargo associated with the order is no longer in the transport box
  • DEMAND_START - performer started to fulfill the demand
  • DEMAND_DONE - performer finished to fulfill the demand
  • DEMAND_CANCELED - the performer canceled the request
  • TRIP_RECEIVED - the performer has received the trip
  • TRIP_CONFIRMED - the performer has agreed to perform the trip
  • TRIP_REJECTED - the performer has refused to perform the trip
  • TRIP_EXECUTED - the performer has started performing the trip
status
required
string (fact_status)
Enum: "NEW" "APPLIED" "ERROR"
Example: "APPLIED"

Current fact status:

  • NEW - the fact has been created and is awaiting system processing
  • APPLIED - the fact has been processed by the system and applied to the data
  • ERROR - an error occurred while processing the fact; the sender must correct the fact and resubmit
status_detail
string or null [ 1 .. 1024 ] characters
Default: null
Example: "duplicate fact"

Additional information about the fact status, used to clarify fact processing errors.

trip_key
required
string [ 1 .. 1024 ] characters
Example: "trip_01"

Trip key, to which the fact relates.

order_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "order_01"

Order key, required for facts with type ORDER_DONE.

demand_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "order_01_demand_01"

Demand key, required for facts with types DEMAND_DONE, DEMAND_CANCELED, DEMAND_START.

performer_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "performer_01"

Performer key, required for facts with type NEW_LOCATION.

location_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "location_01"

Location key, required for facts with type NEW_LOCATION.

object (fact_essences)

Additional entities describing the fact.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (fact)

The fact about the order is the action taken with the order or its part (demand).

object (table_fact_fields)

Fact fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Update fact

Updating the fact by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Essence update request.

key
required
string [ 1 .. 1024 ] characters
Example: "fact_01"

Fact key.

time
required
string <date-time> (fact_time)
Example: "2026-04-21T09:30:00+03:00"

Fact creation time in the ISO 8601 format.

type
required
string (fact_type)
Enum: "NEW_LOCATION" "ORDER_DONE" "DEMAND_START" … 6 more
Example: "NEW_LOCATION"

Possible fact types:

  • NEW_LOCATION - the performer changed his location during the trip
  • ORDER_DONE - the performer has finished fulfilling the order (or the order has been cancelled), the cargo associated with the order is no longer in the transport box
  • DEMAND_START - performer started to fulfill the demand
  • DEMAND_DONE - performer finished to fulfill the demand
  • DEMAND_CANCELED - the performer canceled the request
  • TRIP_RECEIVED - the performer has received the trip
  • TRIP_CONFIRMED - the performer has agreed to perform the trip
  • TRIP_REJECTED - the performer has refused to perform the trip
  • TRIP_EXECUTED - the performer has started performing the trip
status
required
string (fact_status)
Enum: "NEW" "APPLIED" "ERROR"
Example: "APPLIED"

Current fact status:

  • NEW - the fact has been created and is awaiting system processing
  • APPLIED - the fact has been processed by the system and applied to the data
  • ERROR - an error occurred while processing the fact; the sender must correct the fact and resubmit
status_detail
string or null [ 1 .. 1024 ] characters
Default: null
Example: "duplicate fact"

Additional information about the fact status, used to clarify fact processing errors.

trip_key
required
string [ 1 .. 1024 ] characters
Example: "trip_01"

Trip key, to which the fact relates.

order_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "order_01"

Order key, required for facts with type ORDER_DONE.

demand_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "order_01_demand_01"

Demand key, required for facts with types DEMAND_DONE, DEMAND_CANCELED, DEMAND_START.

performer_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "performer_01"

Performer key, required for facts with type NEW_LOCATION.

location_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "location_01"

Location key, required for facts with type NEW_LOCATION.

object (fact_essences)

Additional entities describing the fact.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Response Schema: application/json
required
object (fact)

The fact about the order is the action taken with the order or its part (demand).

object (table_fact_fields)

Fact fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Read fact

Getting fact information by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response Schema: application/json
required
object (fact)

The fact about the order is the action taken with the order or its part (demand).

object (table_fact_fields)

Fact fields for table.

Array of objects (linked_essence_list) [ 0 .. 15001 ] items

A list of linked essences.

Response samples

Content type
application/json
{
}

Deleting one fact

Removing a fact by key.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

List of facts

Getting a facts list.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

query Parameters
offset
integer <int32> [ 0 .. 10000000 ]
Default: 0
Example: offset=10

The number of items to skip before starting to collect the result set.

limit
integer <int32> [ 1 .. 2001 ]
Default: 100
Example: limit=10

The number of items to return.

sort_field
string (table_fact_column_type)
Enum: "ESSENCE_KEY" "ENABLED" "PRISTINE" … 8 more
Example: sort_field=ESSENCE_KEY

Fact table column name.

sort_customfield
string (table_customfields_column_type)
Enum: "DATETIME_0" "DATETIME_1" "DATETIME_2" … 57 more
Example: sort_customfield=STRING_1

The name of the additional column in the table.

sort_direction
string
Default: "ASC"
Enum: "ASC" "DESC"
Example: sort_direction=DESC

Sort direction.

Request Body schema: application/json
optional

Facts filter.

Array of objects (table_fact_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
required
Array of objects (table_fact) [ 0 .. 2001 ] items

Facts list.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete facts (batch)

Removing facts from the file.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Request to delete facts.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Enable facts

Enable facts in the calculation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Enable facts request.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Disable facts

Disable facts in the calculation.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Disable facts request.

Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Responses

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Fact metrics

Calculate general metrics for selected facts.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Data for calculating metrics. If entity keys are specified, metrics are calculated by them. If keys are not specified, metrics are calculated by all entities that fall under the filters.

keys
Array of strings (basic_essence_key_list) [ 0 .. 15001 ] items [ items [ 1 .. 1024 ] characters ]
Example: ["key01"]

A list of keys.

Array of objects (table_fact_filter) [ 0 .. 50 ] items
Default: []

A list of filters.

Responses

Response Schema: application/json
object (table_fact_fields)

Total values for fields of types int, double, duration.

object (table_fact_fields)

Average values for fields of types int, double, duration. Only fields that have a value are taken into account to calculate the average.

required
object (table_list_counters)

Counters by list.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Create facts (batch)

Creating a facts. You can only create a new fact with the 'NEW' status.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

Request Body schema: application/json
required

Facts list creation request.

Array ([ 0 .. 15001 ] items)
key
required
string [ 1 .. 1024 ] characters
Example: "fact_01"

Fact key.

time
required
string <date-time> (fact_time)
Example: "2026-04-21T09:30:00+03:00"

Fact creation time in the ISO 8601 format.

type
required
string (fact_type)
Enum: "NEW_LOCATION" "ORDER_DONE" "DEMAND_START" … 6 more
Example: "NEW_LOCATION"

Possible fact types:

  • NEW_LOCATION - the performer changed his location during the trip
  • ORDER_DONE - the performer has finished fulfilling the order (or the order has been cancelled), the cargo associated with the order is no longer in the transport box
  • DEMAND_START - performer started to fulfill the demand
  • DEMAND_DONE - performer finished to fulfill the demand
  • DEMAND_CANCELED - the performer canceled the request
  • TRIP_RECEIVED - the performer has received the trip
  • TRIP_CONFIRMED - the performer has agreed to perform the trip
  • TRIP_REJECTED - the performer has refused to perform the trip
  • TRIP_EXECUTED - the performer has started performing the trip
status
required
string (fact_status)
Enum: "NEW" "APPLIED" "ERROR"
Example: "APPLIED"

Current fact status:

  • NEW - the fact has been created and is awaiting system processing
  • APPLIED - the fact has been processed by the system and applied to the data
  • ERROR - an error occurred while processing the fact; the sender must correct the fact and resubmit
status_detail
string or null [ 1 .. 1024 ] characters
Default: null
Example: "duplicate fact"

Additional information about the fact status, used to clarify fact processing errors.

trip_key
required
string [ 1 .. 1024 ] characters
Example: "trip_01"

Trip key, to which the fact relates.

order_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "order_01"

Order key, required for facts with type ORDER_DONE.

demand_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "order_01_demand_01"

Demand key, required for facts with types DEMAND_DONE, DEMAND_CANCELED, DEMAND_START.

performer_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "performer_01"

Performer key, required for facts with type NEW_LOCATION.

location_key
string or null [ 1 .. 1024 ] characters
Default: null
Example: "location_01"

Location key, required for facts with type NEW_LOCATION.

object (fact_essences)

Additional entities describing the fact.

Array of objects (attributes) [ 0 .. 250 ] items unique

Attributes. Used to add service information.

Responses

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
}

Tracker

Tracker.

Order mark

Generating a key-mark to track order.

Authorizations:
ApiKeyAuth
path Parameters
file_key
required
string <uuid> (unique_key)
Example: 11111111-2222-3333-4444-555555555555

File key, unique identifier.

essence_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Key, unique identifier.

Responses

Response Schema: application/json
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Response samples

Content type
application/json
"key01"

Order tracking

Order tracking by mark.

path Parameters
tracker_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

Tracker mark, unique identifier.

Responses

Response Schema: application/json
Array of objects (cargo_list) [ 0 .. 1000 ] items unique

The list of cargoes referred to by the demands of this order. The list must be empty if all demands in the order are of type WORK.

required
trip_status (string) or nullable (null)
Default: null

Status.

Array of objects (stop_statistics_list) [ 0 .. 15001 ] items

Statistics on stops related to the tracked order.

Array of objects (fact_list) [ 0 .. 15001 ] items unique

Facts related to the tracked order.

Response samples

Content type
application/json
{
}

Analytics

Analytics.

The main tasks of this block are:

  • creating and storing statistics on trip performance results
  • creating and storing trip performance forecasts

Analytics for the period

Analytics for the period.

Authorizations:
ApiKeyAuth
query Parameters
from
string <date-time>
Example: from=2026-04-21T09:30:00+03:00

Date and time in the ISO 8601 format. If no datetime is specified, audit data are returned from the beginning of the day.

to
string <date-time>
Example: to=2026-04-21T18:00:00+03:00

Date and time in the ISO 8601 format. If not specified, data up to the current time is returned.

Request Body schema: application/json
required

Wave keys list.

Array ([ 0 .. 15001 ] items)
string <uuid> (unique_key)

Key, unique identifier.

Responses

Response Schema: application/json
required
Array of objects (analytics_chart_list) [ 0 .. 10 ] items

A list of charts.

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
}

Reports

Reports.

Report creating

Creating report.

Authorizations:
ApiKeyAuth
query Parameters
from
string <date-time>
Example: from=2026-04-21T09:30:00+03:00

Date and time in the ISO 8601 format. If no datetime is specified, audit data are returned from the beginning of the day.

to
string <date-time>
Example: to=2026-04-21T18:00:00+03:00

Date and time in the ISO 8601 format. If not specified, data up to the current time is returned.

Request Body schema: application/json
required

List of wave keys for which data needs to be downloaded.

Array ([ 0 .. 15001 ] items)
string <uuid> (unique_key)

Key, unique identifier.

Responses

Response Schema: application/octet-stream
string <byte> (file_xlsx)

File with data in XLSX format.

Request samples

Content type
application/json
[ ]

Response samples

Content type
application/json
{
}

Scenarios

Custom trip scenario settings.

Create scenario

Create scenario.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

New scenario.

key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: "key01"

Essence key, unique identifier.

required
Array of objects (scenario_job_list) [ 1 .. 100 ] items

A list of jobs that need to be performed as part of the scenario.

Responses

Response Schema: application/json
key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: "key01"

Essence key, unique identifier.

required
Array of objects (scenario_job_list) [ 1 .. 100 ] items

A list of jobs that need to be performed as part of the scenario.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reading scenario list

Reading the list of scenario keys.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
Array ([ 0 .. 15001 ] items)
string (basic_essence_key) [ 1 .. 1024 ] characters

Essence key, unique identifier.

Response samples

Content type
application/json
[ ]

Update scenario

Update scenario.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

New scenario.

key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: "key01"

Essence key, unique identifier.

required
Array of objects (scenario_job_list) [ 1 .. 100 ] items

A list of jobs that need to be performed as part of the scenario.

Responses

Response Schema: application/json
key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: "key01"

Essence key, unique identifier.

required
Array of objects (scenario_job_list) [ 1 .. 100 ] items

A list of jobs that need to be performed as part of the scenario.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reading scenario

Reading scenario.

Authorizations:
ApiKeyAuth
path Parameters
scenario_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

User scenario key, unique identifier.

Responses

Response Schema: application/json
key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: "key01"

Essence key, unique identifier.

required
Array of objects (scenario_job_list) [ 1 .. 100 ] items

A list of jobs that need to be performed as part of the scenario.

Response samples

Content type
application/json
{
}

Delete scenario

Delete scenario.

Authorizations:
ApiKeyAuth
path Parameters
scenario_key
required
string (basic_essence_key) [ 1 .. 1024 ] characters
Example: key01

User scenario key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

User

User interface settings.

Setting the active user settings key

Setting the active user settings key.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

New key.

string (settings_key) [ 1 .. 1024 ] characters

Settings key, unique identifier.

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
Example: ["path-key-01"]

List of setting keys.

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Key of the currently active setting. A key from the settings_keys list, or null (if there is no active setting).

Request samples

Content type
application/json
"path-key-01"

Response samples

Content type
application/json
{
}

Reading user settings list

Reading the list of user settings keys.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
Example: ["path-key-01"]

List of setting keys.

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Key of the currently active setting. A key from the settings_keys list, or null (if there is no active setting).

Response samples

Content type
application/json
{
}

Create user settings

Create user settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Request Body schema: application/json
required

New settings.

property name*
additional property
any

Responses

Response Schema: application/json
property name*
additional property
any

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reading user settings

Reading user settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Responses

Response Schema: application/json
property name*
additional property
any

Response samples

Content type
application/json
{
}

Update user settings

Update user settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Request Body schema: application/json
required

New settings.

property name*
additional property
any

Responses

Response Schema: application/json
property name*
additional property
any

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete user settings

Delete user settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

CustomFields

Custom field conversion settings.

The table provides additional columns for displaying values ​​from attributes.

This setting defines the rules for converting attribute values ​​into the corresponding typed fields.

Conversion occurs when reading data - therefore, the conversion rules do not affect the data and can be changed at any time.

Setting the active customfields key

Setting the active customfields key.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

New key.

string (settings_key) [ 1 .. 1024 ] characters

Settings key, unique identifier.

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
Example: ["path-key-01"]

List of setting keys.

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Key of the currently active setting. A key from the settings_keys list, or null (if there is no active setting).

Request samples

Content type
application/json
"path-key-01"

Response samples

Content type
application/json
{
}

Reading fields settings list

Reading the list of custom field settings keys.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
Example: ["path-key-01"]

List of setting keys.

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Key of the currently active setting. A key from the settings_keys list, or null (if there is no active setting).

Response samples

Content type
application/json
{
}

Create fields settings

Create custom fields settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Request Body schema: application/json
required

New settings.

required
Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

List of rules for converting custom fields.

Responses

Response Schema: application/json
required
Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

List of rules for converting custom fields.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Reading fields settings

Reading custom field settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Responses

Response Schema: application/json
required
Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

List of rules for converting custom fields.

Response samples

Content type
application/json
{
}

Update fields settings

Update custom fields settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Request Body schema: application/json
required

New settings.

required
Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

List of rules for converting custom fields.

Responses

Response Schema: application/json
required
Array of objects (customfield_convert_rule) [ 0 .. 100 ] items unique

List of rules for converting custom fields.

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Delete fields settings

Delete custom fields settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

CustomIcons

Icon settings.

Setting the active customicons key

Setting the active customicons key.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required

New key.

string (settings_key) [ 1 .. 1024 ] characters

Settings key, unique identifier.

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
Example: ["path-key-01"]

List of setting keys.

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Key of the currently active setting. A key from the settings_keys list, or null (if there is no active setting).

Request samples

Content type
application/json
"path-key-01"

Response samples

Content type
application/json
{
}

Reading icons settings list

Reading the list of custom field settings keys.

Authorizations:
ApiKeyAuth

Responses

Response Schema: application/json
settings_keys
required
Array of strings (settings_key) [ 0 .. 10 ] items unique [ items [ 1 .. 1024 ] characters ]
Example: ["path-key-01"]

List of setting keys.

active_key
string or null (settings_key_null) [ 1 .. 1024 ] characters
Example: "path-key-01"

Key of the currently active setting. A key from the settings_keys list, or null (if there is no active setting).

Response samples

Content type
application/json
{
}

Update icons settings

Create custom icons settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Request Body schema: application/octet-stream
required

New settings.

string <byte> (file_zip)

ZIP archive with data.

Responses

Response samples

Content type
application/json
{
}

Reading icons settings

Reading custom field settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Responses

Response Schema: application/octet-stream
string <byte> (file_zip)

ZIP archive with data.

Response samples

Content type
application/json
{
}

Update icons settings

Update custom icons settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Request Body schema: application/octet-stream
required

New settings.

string <byte> (file_zip)

ZIP archive with data.

Responses

Response samples

Content type
application/json
{
}

Delete icons settings

Delete custom icons settings.

Authorizations:
ApiKeyAuth
path Parameters
settings_key
required
string (settings_key) [ 1 .. 1024 ] characters
Example: path-key-01

User settings key, unique identifier.

Responses

Response samples

Content type
application/json
{
}

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

Content type
application/json
{
}

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

Content type
application/json
{
}

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:
string (file_html) [ 0 .. 2000000000 ] characters

File with data in HTML format.

Response samples

Content type
application/json
{
}