Работа с отчетами План / Факт

Отчеты План / Факт — это инструмент для анализа точности планирования и получения сводной информации о фактических показателях.

В анализе участвуют все планирования и маршруты по всем складам компании, которые загрузили в Мониторинг. В отчетах плановые показатели сравниваются с фактическими данными по уже реализованным маршрутам.

Данные для отчета План / Факт формируются ежедневно в 00:00 GMT+3. Если маршрут завершился после полуночи, актуальные данные по нему попадут в отчет только на следующий день.

Загрузить план в Мониторинг

Чтобы получить сравнительную информацию по плановым и фактическим показателям, передайте в Мониторинг решение, полученное в сервисе Планирования. Если этого не сделать, в отчете окажутся только фактические показатели.

В отчетах не учитывается последующее редактирование маршрута менеджером в Рабочем месте логиста или курьером в приложении Яндекс Маршрутизация.

Способ загрузки плана в Мониторинг зависит от выбранного компанией способа взаимодействия с сервисом.

Через интерфейс Рабочего места логиста

План сохраняется в момент экспорта маршрута в Мониторинг:

1. Спланируйте маршрут через сервис Планирования.
2. Нажмите Экспортировать.
3. В окне Экспортировать решение выберите Мониторинг.

Через API

Отправьте запрос к ресурсу route-plans. В запросе нужно указать информацию о маршруте и заказах.

curl -H "Content-Type: application/json" -H "Authorization: OAuth <ваш-токен>" -X POST -d @<Путь_до_файла_в_кодировке_UTF-8> -i https://courier.yandex.ru/api/v1/companies/<id-вашей-компании>/route-plans

[
  {
    "number":"101-2_2017-10-23",
    "nodes":[
      {
        "type":"depot",
        "arrival_time_s":25200,
        "transit_distance_m":0,
        "value":{
          "number":"0",
          "point":{
            "lat":55.799087,
            "lon":37.729377
          },
          "service_duration_s":200
        }
      },
      {
        "type":"order",
        "arrival_time_s":57526,
        "departure_time_s":57526,
        "transit_distance_m":8723,
        "used_time_window":"10:00-12:00",
        "value":{
          "number":"126",
          "point":{
            "lat":55.826326,
            "lon":37.637686
          },
          "service_duration_s":0
        }
      },
      {
        "type":"order",
        "arrival_time_s":57546,
        "departure_time_s":57546,
        "transit_distance_m":87423,
        "used_time_window":"10:00-12:00",
        "value":{
          "number":"2345",
          "address":"Address",
          "point":{
            "lat":55.826426,
            "lon":37.647686
          },
          "service_duration_s":0,
          "shared_service_duration_s":0,
          "multi_order":false,
          "customer_name":"Name",
          "shipment_size":{
            "volume_cbm":1.2,
            "weight_kg":5.1,
            "amount":4.5
          }
        }
      }
    ]
  }
]

Построить отчет

Через интерфейс рабочего места логиста

1. Перейдите в раздел Отчеты → План/Факт.

2. Нажмите Большой отчёт в Excel.

3. Нажмите Выберите период, чтобы задать временные рамки для запланированных и выполненных маршрутов, которые нужно проанализировать.

   Вы можете как выбрать один из преднастроенных периодов (Вчера, 7 дней, 30 дней, Прошлый месяц), так и задать собственный произвольной продолжительности, но не более 60 дней.

   Ескерту

   При выборе учитывайте, что текущий день недоступен для построения отчета, даже если интересующие вас маршруты уже завершены.

4. Нажмите Подготовить.

   После выбора периода в правом верхнем углу появится значок , означающий, что отчет готовится. В это время вы можете продолжать работать в любом разделе интерфейса Рабочего места логиста.

Через API

Вы можете получить данные двумя методами:

• получить только плановые метрики;
• получить план-факт для каждой точки маршрута.

Получить только плановые метрики

Отправьте запрос к ресурсу route-plan-info. Этот метод возвращает список маршрутов с их плановыми показателями.

Запрос

cURL

curl -H "Authorization: OAuth <ваш-токен>" -X GET https://courier.yandex.ru/api/v1/companies/<id-вашей-компании>/route-plan-info

Результат

[
  {
    "id": 17872948,
    "number": "0-1-2025-03-13",
    "date": "2025-02-08",
    "plan_metrics": {
    "orders_count": 2,
    "total_transit_distance_m": 10534,
      "total_duration": {
        "value": 2882,
        "text": "0:48:02"
      }
    }
  },
  {
    "id": 18508527,
    "number": "1-1-2025-04-02",
    "date": "2025-02-12",
    "plan_metrics": {
      "orders_count": 4,
      "total_transit_distance_m": 98554,
      "total_duration": {
        "value": 10886,
        "text": "3:01:26"
      }
    }
  },
  {
    "id": 18280581,
    "number": "2-1-2025-03-13",
    "date": "2025-03-11",
    "plan_metrics": {
    "orders_count": 2,
    "total_transit_distance_m": 43246,
    "total_duration": {
        "value": 31546,
        "text": "8:45:46.358154"
      }
    }
  }
]

Чтобы получить отчет о маршрутах за определенный период, используйте параметры start_date и end_date. Обе даты указываются включительно.

Пример

Получить отчет по маршрутам за 12 и 13 марта 2025 года.

curl -H "Authorization: OAuth <ваш-токен>" -X GET https://courier.yandex.ru/api/v1/companies/<id-вашей-компании>/route-plan-info?start_date=2025-03-12&end_date=2025-03-13

Подробнее о параметрах запроса см. в документации route-plan-info.

Получить план-факт для каждой точки маршрута

Отправьте запрос к ресурсу plan-fact-versioned-nodes. Этот метод возвращает детальную информацию о каждой точке маршрута с плановыми и фактическими показателями.

Как получить данные

1. Для первоначальной выгрузки отправьте запрос с prev_version = 0.

   Запрос

   curl -H "Authorization: OAuth <ваш-токен>" -X GET "https://courier.yandex.ru/api/v1/analytics/companies/<id-вашей-компании>/plan-fact/versioned/nodes?prev_version=0"
   

   Результат

   В ответе вы получите версию и данные:

   {
     "version": "1234567890123",
     "data": [
       {
         "route": {
           "id": 22821698,
           "number": "0-1-2024-08-13",
           "date": "2024-08-13"
         },
         "courier": {
           "id": 4428812,
           "number": "Courier 1",
           "name": "Courier 1"
         },
         "depot": {
           "id": 109787,
           "number": "100",
           "name": "Depot",
           "timezone": "Europe/Moscow"
         },
          "fact": {
           "type": "depot",
           "status": "unvisited",
           "address": "улица Льва Толстого, 16, Москва, Россия",
           "point": {
             "lat": 55.733969,
             "lon": 37.587093
           },
           "arrival_time": null,
           "departure_time": null
           // ... другие поля
         },
         "plan": {
           "type": "depot",
           "address": "улица Льва Толстого, 16, Москва, Россия",
           "point": {
             "lat": 55.733969,
             "lon": 37.587093
           },
           "arrival_time": {
             "value": 1723525200,
             "text": "2024-08-13T08:00:00+03:00"
           },
           "departure_time": {
             "value": 1723525200,
             "text": "2024-08-13T08:00:00+03:00"
           }
           // ... другие поля
         },
         "version_status": "added"
       }
       // ... другие точки маршрута
     ]
   }
   

2. Повторите запрос, указав полученную версию в prev_version.

   Запрос

   curl -H "Authorization: OAuth <ваш-токен>" -X GET "https://courier.yandex.ru/api/v1/analytics/companies/<id-вашей-компании>/plan-fact/versioned/nodes?prev_version=1769642737915"
   

   Результат

   Вы получите актуальные данные:

   {
     "version": "1234567890123",
     "data": [
       {
         "route": {
           "id": 22821698,
           "number": "0-1-2024-08-13",
           "date": "2024-08-13"
         },
         "courier": {
           "id": 4428812,
           "number": "Courier 1",
           "name": "Courier 1"
         },
         "depot": {
           "id": 109787,
           "number": "100",
           "name": "Depot",
           "timezone": "Europe/Moscow"
         },
         "fact": {
           "type": "depot",
           "sequence_pos": 0,
           "real_sequence_pos": 0,
           "status": "unvisited",
           "number": "0",
           "customer_name": null,
           "address": "улица Льва Толстого, 16, Москва, Россия",
           "failed_time_window": false,
           "point": {
             "lat": 55.764744,
             "lon": 37.522144
           }
           // ... другие поля
         },
         "plan": {
           // ... плановые показатели
         }
         // ... другие поля
       }
       // ... другие точки маршрута
     ]
   }
   

   Если массив data пустой, с момента предыдущего запроса новых данных нет.

Если данных много, используйте параметры page и per_page для постраничной загрузки. Подробнее см. в документации plan-fact-versioned-nodes.

Скачать отчет

Когда отчет будет готов, появится уведомление с названием отчета (формируется автоматически и содержит даты начала и конца периода сравнения).

Нажмите кнопку Скачать, чтобы получить готовый отчет. Если вы закроете уведомление, то сможете вернуться к списку доступных отчетов позже. Для этого нажмите значок в правом верхнем углу.

Описание полей отчета см. в разделе План / Факт.