---
# System prepended metadata

title: Vehicle Report API

---

# Vehicle Report API

[TOC]


---

### Vehicle Weekly Report
- path: /web_api/weekly_report/v1/vehicle/:IMEI/:startTime,:endTime/asc 
- method: GET
- response: 
```jsonld
{
  "status": 200,
  "errcode": "",
  "message": "API execution succeeded",
  "data": [
    {
      "queryDate": [    //每日數據
        {
          "distance": {    //每日旅程距離
            "distance": 154,
            "speedDistance": 155.66,
            "gpsDistance": 160.29
          },
          "dayOfWeek": 6,    //0=星期日,以此類推
          "tripsCount": 3,    //每日旅程數
          "fuelUsed": 8.2,    //每日油耗
          "time": 10256,    //每日旅程時間
          "distanceWithoutRPM": 101.1,    //每日旅程距離(無RPM時) (NEW)
          "idleFuelUsed": 8.2,    //每日怠速油耗 (New)
          "idleTime": 10256    //每日怠速時間 (New)
        }
      ],
      "travelDistance": {    //當週總距離
        "rankCount": 67,    //排名(全部人數) 全部IMEI的数量，然后根据speedDistance，gpsDistance进行排序
        "rankData": [
          {
            "distance": {    //當週總距離
              "distance": 673,
              "speedDistance": 682.97,
              "gpsDistance": 703.82
            },
            "rankIndex": 63    //排名(第幾名)
          }
        ]
      },
      "yearToWeekDistance": {    //年度累計距離
        "rankCount": 186,
        "rankData": [
          {
            "distance": {
              "distance": 4246,
              "speedDistance": 4709.97,
              "gpsDistance": 4216.31
            },
            "rankIndex": 181
          }
        ]
      },
      "totalFuelUsed": {    //當週總計油耗
        "rankCount": 67,
        "rankData": [
          {
            "fuelUsed": 39.62,
            "rankIndex": 64
          }
        ]
      },
      "averageFuelEconomy": {    //當周平均油耗
        "rankCount": 67,
        "rankData": [
          {
            "averageFuelEconomy": 17.24,
            "rankIndex": 65
          }
        ]
      },
      "totalTrip": {    //當周旅程總數
        "rankCount": 67,
        "rankData": [
          {
            "tripsCount": 20,
            "rankIndex": 42
          }
        ]
      },
      "totalTripTime": {
        "rankCount": 67,
        "rankData": [
          {
            "totalTripTime": 53460,
            "rankIndex": 58
          }
        ]
      },
      "distanceWithoutRPM": {    //當週總距離(沒有RPM時) (New)
        "rankCount": 67,
        "rankData": [
          {
            "distanceWithoutRPM": 101.1,
            "rankIndex": 63
          }
        ]
      },
      "idleFuelUsed": {    //當周怠速油耗 (New)
        "rankCount": 67,
        "rankData": [
          {
            "idleFuelUsed": 39.62,
            "rankIndex": 64
          }
        ]
      },
      "idleTime": {    //當周怠速時間 (New)
        "rankCount": 67,
        "rankData": [
          {
            "idleTime": 53460,
            "rankIndex": 58
          }
        ]
      },
      "hybridPerformance": {    //性能分析資料New
        "speedBattery": 0,    //速度(使用電池時)
        "idleBattery": 0,    //怠速(使用電池時)
        "speedFuel": 0,    //速度(使用燃油時)   
        "idleFuel": 0    //怠速(使用燃油時)
      },
      "speedAnalysis": {    //速度分析
        "highSpeed": 0,    //高速
        "mediumSpeed": 0,    //中速
        "lowSpeed": 0,    //低速
        "idle": 0    //怠速
      }
    }
  ]
}
```

---

### Vehicle Monthly Report
- path: /web_api/monthly_report/v1/vehicle/:IMEI/:startTime,:endTime/asc
- method: GET
- response: 
```jsonld
{
  "status": 200,
  "errcode": "",
  "message": "API execution succeeded",
  "data": [
    {
      "queryDate": [    //每日數據
        {
          "distance": {    //當日距離
            "distance": 85,
            "speedDistance": 85.03,
            "gpsDistance": 88.46
          },
          "dayOfMonth": 1,    //當月的幾號
          "tripsCount": 3,    //當日總旅程數
          "averageFuelEconomy": 17.18,    //當日平均油耗
          "fuelUsed": 4.95,    //當日油耗
          "time": 6978,    //當日旅程時間
          "distanceWithoutRPM": 101.1,    //當日距離(沒有RPM)時New
          "idleFuelUsed": 8.2,    //當日怠速油耗New
          "idleTime": 10256    //當日怠速時間New
        }
      ],
      "travelDistance": {    //當月旅程總距離
        "rankCount": 78,
        "rankData": [
          {
            "distance": {
              "distance": 1694,
              "speedDistance": 1708.19,
              "gpsDistance": 1725.66
            },
            "rankIndex": 74
          }
        ]
      },
      "averageFuelEconomy": {    //當月平均油耗
        "rankCount": 78,
        "rankData": [
          {
            "averageFuelEconomy": 16.87,
            "rankIndex": 74
          }
        ]
      },
      "totalFuelUsed": {    //當月油耗
        "rankCount": 78,
        "rankData": [
          {
            "fuelUsed": 101.25,
            "rankIndex": 75
          }
        ]
      },
      "totalTrip": {    //當月旅程總數
        "rankCount": 78,
        "rankData": [
          {
            "tripsCount": 56,
            "rankIndex": 59
          }
        ]
      },
      "yearToMonthDistance": {    //年度累計距離
        "rankCount": 186,
        "rankData": [
          {
            "distance": {
              "distance": 4708,
              "speedDistance": 5173.24,
              "gpsDistance": 4658
            },
            "rankIndex": 181
          }
        ]
      },
      "totalTripTime": {    //當月總旅程時間
        "rankCount": 78,
        "rankData": [
          {
            "totalTripTime": 135675,
            "rankIndex": 70
          }
        ]
      },
      "distanceWithoutRPM": {    //當月距離(沒有RPM時)New
        "rankCount": 67,
        "rankData": [
          {
            "distanceWithoutRPM": 101.1,
            "rankIndex": 63
          }
        ]
      },
      "idleFuelUsed": {    //當月怠速油耗New
        "rankCount": 67,
        "rankData": [
          {
            "idleFuelUsed": 39.62,
            "rankIndex": 64
          }
        ]
      },
      "idleTime": {    //當月怠速時間New
        "rankCount": 67,
        "rankData": [
          {
            "idleTime": 53460,
            "rankIndex": 58
          }
        ]
      },
      "hybridPerformance": {    //性能分析資料New
        "speedBattery": 0,    //速度(使用電池時)
        "idleBattery": 0,    //怠速(使用電池時)
        "speedFuel": 0,    //速度(使用燃油時)   
        "idleFuel": 0    //怠速(使用燃油時)
      },
      "speedAnalysis": {    //速度分析
        "highSpeed": 0,    //高速
        "mediumSpeed": 0,    //中速
        "lowSpeed": 0,    //低速
        "idle": 0    //怠速
      }
    }
  ]
}
```