> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mobway.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# POST vehicle-trips

> Retorna os dados das viagens dos veículos conectados à empresa

<Info>Apesar de ser uma requisição POST, está rota não se destina a criar um recurso na API. Foi desenvolvida desta forma pela comodidade de customizar o payload a ser enviado no corpo da requisição.</Info>

## Request

##### **Header**

<ParamField body="token" type="string" required={true}>
  É o token ao portador utilizado para autenticar a empresa.
</ParamField>

##### **Body**

<ParamField body="vins" type="list of strings" required={true}>
  Indica a lista de Vehicle Identification Number (VIN) dos veículos os quais se deseja recuperar os dados.
</ParamField>

<ParamField body="datapoints" type="list of strings" required={true}>
  Indica a lista de [pontos de dados das viagens](https://docs.mobway.cloud/data/trip) que se deseja recuperar dos veículos. As opções são:

  * start\_date\_time: Data e Hora de Início da Viagem \[YYYY-MM-DDTHH:MM:SS]
  * end\_date\_time: Data e Hora de Fim da Viagem \[YYYY-MM-DDTHH:MM:SS]
  * duration: Duração da Viagem \[HH:MM:SS]
  * avg\_speed: Velocidade Média \[km/h]
  * max\_speed: Velocidade Máxima \[km/h]
  * start\_odometer: Odômetro de Início \[km]
  * end\_odometer: Odômetro de Fim \[km]
  * distance: Distância Percorrida \[km]
  * avg\_fuel\_consumption: Consumo Médio de Combustível \[L]
  * start\_latitude: Latitude de Início \[°]
  * start\_longitude: Longitude de Início \[°]
  * end\_latitude: Latitude de Fim \[°]
  * end\_longitude: Longitude de Fim \[°]
</ParamField>

<ParamField body="start_date" type="date or datetime">
  É um parâmetro opcional e pode ser usado para filtrar a data de início dos dados da viagem. Deve ser enviado nos seguintes formatos: YYYY-MM-DD ou YYYY-MM-DDTHH:MM:SS (ISO 8601). Caso o formato escolhido seja YYYY-MM-DD, para os propósitos do filtro, será considerado o seguinte horário: YYYY-MM-DDT00:00:00
</ParamField>

<ParamField body="end_date" type="date or datetime">
  Também é um parâmetro opcional para filtrar a data de fim dos dados da viagem. Segue os mesmos formatos: YYYY-MM-DD ou YYYY-MM-DDTHH:MM:SS (ISO 8601). Caso o formato escolhido seja YYYY-MM-DD, para os propósitos do filtro, será considerado o seguinte horário: YYYY-MM-DDT23:59:59
</ParamField>

<Info>Quando forem utilizados start\_date e end\_date, as viagens selecionadas serão as que pelo menos uma parte pertence ao período selecionado, da seguinte forma: (end\_date >= start\_date\_time) | (end\_date\_time >= start\_date)</Info>

## Response

<Tip>Para informações mais detalhadas sobre a resposta, consultar em [Pontos de Dados de Viagens](https://docs.mobway.cloud/data/trip)</Tip>

<ResponseField name="vin" type="string">
  Indica o número de identificação único do veículo.
</ResponseField>

<ResponseField name="start_date_time" type="datetime">
  Indica o data e horário de início \[YYYY-MM-DDTHH:MM:SS].
</ResponseField>

<ResponseField name="end_date_time" type="datetime">
  Indica o data e horário de fim \[YYYY-MM-DDTHH:MM:SS].
</ResponseField>

<ResponseField name="duration" type="interval">
  Indica a duração \[HH:MM:SS].
</ResponseField>

<ResponseField name="avg_speed" type="number">
  Indica a velocidade média \[km/h].
</ResponseField>

<ResponseField name="max_speed" type="number">
  Indica a velocidade máxima \[km/h].
</ResponseField>

<ResponseField name="start_odometer" type="number">
  Indica o odômetro inicial \[km].
</ResponseField>

<ResponseField name="end_odometer" type="number">
  Indica o odômetro final \[km].
</ResponseField>

<ResponseField name="distance" type="number">
  Indica a distância percorrida \[km].
</ResponseField>

<ResponseField name="avg_fuel_consumption" type="number">
  Indica o consumo médio de combustível \[km/l].
</ResponseField>

<ResponseField name="start_latitude" type="number">
  Indica a latitude do início \[km/l].
</ResponseField>

<ResponseField name="start_latitude" type="number">
  Indica a latitude do início \[°].
</ResponseField>

<ResponseField name="end_latitude" type="number">
  Indica a latitude do fim \[°].
</ResponseField>

<ResponseField name="end_longitude" type="number">
  Indica a longitude do fim \[°].
</ResponseField>

<RequestExample>
  ```bash Exemplo de Requisição theme={null}
  curl --request POST \
    --url https://api.mobway.cloud/vehicle-trips \
    --header 'Authorization: Bearer <token>' \
    --data '{
      "vins": [
          {vins}
      ],
      "datapoints": [
          "start_date_time",
          "end_date_time",
          "duration",
          "avg_speed",
          "max_speed",
          "start_odometer",
          "end_odometer",
          "distance",
          "avg_fuel_consumption",
          "start_latitude",
          "start_longitude",
          "end_latitude",
          "end_longitude"
      ],
      "start_date": {start_date},
      "end_date": {end_date}
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json Resposta theme={null}
  {
    "6AHFT68CKAF501652": [
      {
        "start_date_time": "2023-02-13T05:42:46",
        "end_date_time": "2023-02-13T08:46:46",
        "duration": "03:04:00",
        "avg_speed": 29.45,
        "max_speed": 44.64,
        "start_odometer": 805819.25,
        "end_odometer": 805909.5633333334,
        "distance": 90.31333333335351,
        "avg_fuel_consumption": 14.5,
        "start_latitude": 55.697482,
        "start_longitude": -177.660447,
        "end_latitude": 55.750181,
        "end_longitude": -177.740005
      },
      {
        "start_date_time": "2023-02-13T08:46:46",
        "end_date_time": "2023-02-13T11:59:46",
        "duration": "03:13:00",
        "avg_speed": 69.32,
        "max_speed": 87.84,
        "start_odometer": 805909.5633333334,
        "end_odometer": 806132.5426666667,
        "distance": 222.97933333332185,
        "avg_fuel_consumption": 18.41,
        "start_latitude": 55.750181,
        "start_longitude": -177.740005,
        "end_latitude": 55.811607,
        "end_longitude": -177.694059
      }
    ]
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.