Получить план-факт для маршрутов по версии

  1. HTTP-запрос
  2. Path-параметры
  3. Query-параметры
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 400
    3. Код 403
    4. Код 422
    5. Код 500

Возвращает все обновления план-факта, возникшие после переданной предыдущей версии, для маршрутов компании.

HTTP-запрос

GET https://courier.yandex.ru/api/v1/analytics/companies/{company_id}/plan-fact/versioned/routes\
?prev_version={string}\
&page={integer}\
&per_page={integer}

Path-параметры

company_id *

integer

ID компании, используемый в запросах к API Мониторинга.

company_id *

integer

ID компании, используемый в запросах к API Мониторинга.

Query-параметры

prev_version *

string

Версия, полученная на пролшом вызове данного метода. Для первоначальной выгрузки используйте значение 0

page

integer

Номер страницы. Каждая страница содержит per_page объектов.

Минимальное значение: 1.
Значение по умолчанию: 1.

per_page

integer

Количество маршрутов на страницу.

Минимальное значение: 1.
Максимальное значение: 1000.
Значение по умолчанию: 200.

prev_version *

string

Версия, полученная на пролшом вызове данного метода. Для первоначальной выгрузки используйте значение 0

page

integer

Номер страницы. Каждая страница содержит per_page объектов.

Минимальное значение: 1.
Значение по умолчанию: 1.

per_page

integer

Количество маршрутов на страницу.

Минимальное значение: 1.
Максимальное значение: 1000.
Значение по умолчанию: 200.

Ответы

Код 200

Успех.

{
  "data": [
    {
      "courier": {
        "id": integer,
        "name": string,
        "number": string,
        "phone": string
      },
      "date": string,
      "depot": {
        "address": string,
        "id": integer,
        "name": string,
        "number": string,
        "timezone": string
      },
      "fact": {
        "courier_violated_route": boolean,
        "delivered_orders_count": integer,
        "has_positions": boolean,
        "nodes_count": integer,
        "orders_count": integer,
        "orders_with_status_comments_count": integer,
        "plan_violated": boolean,
        "processed_orders_count": integer,
        "total_depot_idle_count": integer,
        "total_depot_idle_duration_s": integer,
        "total_failed_time_window_count": integer,
        "total_no_connection_count": integer,
        "total_no_connection_duration_s": integer,
        "total_order_idle_count": integer,
        "total_order_idle_duration_s": integer,
        "total_service_duration_depots_s": integer,
        "total_service_duration_orders_s": integer,
        "total_transit_distance_m": number,
        "total_transit_duration_s": integer,
        "total_transit_idle_count": integer,
        "total_transit_idle_duration_s": integer
      },
      "id": integer,
      "imei": integer,
      "number": string,
      "plan": {
        "nodes_count": integer,
        "orders_count": integer,
        "total_duration_s": integer,
        "total_failed_time_window_count": integer,
        "total_service_duration_s": integer,
        "total_transit_distance_m": number,
        "total_transit_duration_s": integer
      },
      "version_status": string
    }
  ],
  "version": string
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

data[] *

array

data[].courier *

object

data[].courier.id *

integer

data[].courier.name *

string

data[].courier.number *

string

data[].courier.phone *

string

data[].date *

string

data[].depot *

object

data[].depot.address *

string

data[].depot.id *

integer

data[].depot.name *

string

data[].depot.number *

string

data[].depot.timezone *

string

data[].fact *

object

data[].fact.courier_violated_route *

boolean

data[].fact.delivered_orders_count *

integer

data[].fact.has_positions *

boolean

data[].fact.nodes_count *

integer

data[].fact.orders_count *

integer

data[].fact.orders_with_status_comments_count *

integer

data[].fact.plan_violated *

boolean

data[].fact.processed_orders_count *

integer

data[].fact.total_depot_idle_count *

integer

data[].fact.total_depot_idle_duration_s *

integer

data[].fact.total_failed_time_window_count *

integer

data[].fact.total_no_connection_count *

integer

data[].fact.total_no_connection_duration_s *

integer

data[].fact.total_order_idle_count *

integer

data[].fact.total_order_idle_duration_s *

integer

data[].fact.total_service_duration_depots_s *

integer

data[].fact.total_service_duration_orders_s *

integer

data[].fact.total_transit_distance_m *

number

data[].fact.total_transit_duration_s *

integer

data[].fact.total_transit_idle_count *

integer

data[].fact.total_transit_idle_duration_s *

integer

data[].id *

integer

data[].imei *

integer

data[].number *

string

data[].plan *

object

data[].plan.nodes_count *

integer

data[].plan.orders_count *

integer

data[].plan.total_duration_s *

integer

data[].plan.total_failed_time_window_count *

integer

data[].plan.total_service_duration_s *

integer

data[].plan.total_transit_distance_m *

number

data[].plan.total_transit_duration_s *

integer

data[].version_status *

string

Тип изменения в версии.

Возможные значения
  1. added
  2. modified
  3. deleted

version *

string

data[] *

array

data[].courier *

object

data[].courier.id *

integer

data[].courier.name *

string

data[].courier.number *

string

data[].courier.phone *

string

data[].date *

string

data[].depot *

object

data[].depot.address *

string

data[].depot.id *

integer

data[].depot.name *

string

data[].depot.number *

string

data[].depot.timezone *

string

data[].fact *

object

data[].fact.courier_violated_route *

boolean

data[].fact.delivered_orders_count *

integer

data[].fact.has_positions *

boolean

data[].fact.nodes_count *

integer

data[].fact.orders_count *

integer

data[].fact.orders_with_status_comments_count *

integer

data[].fact.plan_violated *

boolean

data[].fact.processed_orders_count *

integer

data[].fact.total_depot_idle_count *

integer

data[].fact.total_depot_idle_duration_s *

integer

data[].fact.total_failed_time_window_count *

integer

data[].fact.total_no_connection_count *

integer

data[].fact.total_no_connection_duration_s *

integer

data[].fact.total_order_idle_count *

integer

data[].fact.total_order_idle_duration_s *

integer

data[].fact.total_service_duration_depots_s *

integer

data[].fact.total_service_duration_orders_s *

integer

data[].fact.total_transit_distance_m *

number

data[].fact.total_transit_duration_s *

integer

data[].fact.total_transit_idle_count *

integer

data[].fact.total_transit_idle_duration_s *

integer

data[].id *

integer

data[].imei *

integer

data[].number *

string

data[].plan *

object

data[].plan.nodes_count *

integer

data[].plan.orders_count *

integer

data[].plan.total_duration_s *

integer

data[].plan.total_failed_time_window_count *

integer

data[].plan.total_service_duration_s *

integer

data[].plan.total_transit_distance_m *

number

data[].plan.total_transit_duration_s *

integer

data[].version_status *

string

Тип изменения в версии.

Возможные значения
  1. added
  2. modified
  3. deleted

version *

string

Код 400

Недопустимые параметры были переданы.

Код 403

У вас нет доступа к этому объекту.

Код 422

Неправильный ввод.

Код 500

Ошибка сервера при обработке запроса.