{"info":{"_postman_id":"9a749511-38cc-49e3-9bae-01a95285141e","name":"Gobrax API - Estatísticas V2","description":"<html><head></head><body><h3 id=\"authentication\">Authentication</h3>\n<p>A verificação de segurança é feita em toda requisição através do token de API.</p>\n<p>O token deve estar presente em todas as requisições.</p>\n<p>O token será fornecido pela Gobrax após a assinatura de contrato de uso da API, mande um email para <a href=\"https://mailto:suporte@gobrax.com.br\">suporte@gobrax.com.br</a> tanto para criação quanto para manutenção do seu token.&nbsp;</p>\n<p>O token de segurança deve estar presente no header (cabeçalho) das requisições e seguir o padrão, como no exemplo abaixo sem as aspas ou espaços antes ou depois:  </p>\n<blockquote>\n<p>Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJHb2JyYXgiOjF9.KpILLSFkfb2WvCWcCV_YYxzYZ-qGPYfbZ504aSGlSE8</p>\n</blockquote>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"27100945","collectionId":"9a749511-38cc-49e3-9bae-01a95285141e","publishedId":"2s93eU4FGF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-05-02T23:09:01.000Z"},"item":[{"name":"Vehicles Statistics","id":"1d45d451-b2d7-4cf2-b57a-edd22308e212","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"<token>"}]},"isInherited":false},"method":"GET","header":[],"url":"https://gateway-v3.gobrax.com.br:8889/api/v1/vehicle-statistics?startDate=2021-02-10 00:00:00&endDate=2021-02-10 23:59:59&vehicleIdentification=","description":"<h3 id=\"vehicle-statistic\">Vehicle Statistic</h3>\n<p>API responsável por apresentar os dados estatísticos dos veículos num determinado período de tempo. Isso quer dizer que os dados serão consolidados e calculados de acordo com o período selecionado para análise. Por exemplo, se a requisição possuir data inicial (startDate) “2024-10-11 00:00:00” e data final (endDate) “2024-10-11 23:59:59” a API irá retornar os dados calculados para esse período selecionado.  </p>\n<p>Os seguintes dados serão disponibilizados em todas as requisições:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Field</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Description</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>vehicleIdentification</td>\n<td>string</td>\n<td>Identificação do veículo em nosso banco de dados, que por padrão recebe a PLACA do mesmo, sem espaços ou caracteres de separação (como hífens ou barras).  <br />  <br />Exemplo: ABC1234</td>\n</tr>\n<tr>\n<td>startDate</td>\n<td>string</td>\n<td>Data inicial da análise, indicada na requisição realizada.  <br />  <br /><strong>- A data é expressada seguindo o padrão UTC  <br />- Exemplo: “2024-01-01 00:00:00”</strong></td>\n</tr>\n<tr>\n<td>endDate</td>\n<td>string</td>\n<td>Data final da análise, indicada na requisição realizada.  <br />  <br /><strong>- A data é expressada seguindo o padrão UTC  <br />- Exemplo: “2024-01-01 23:59:59”</strong></td>\n</tr>\n<tr>\n<td>averageSpeed</td>\n<td>float</td>\n<td>Média de velocidade do veículo no período analisado.  <br />  <br /><strong>A velocidade média será expressada em quilômetros por hora (Km/h).</strong></td>\n</tr>\n<tr>\n<td>consumptionAverage</td>\n<td>float</td>\n<td>Média de consumo do veículo no período analisado.  <br />  <br /><strong>A média será expressada em quilômetros por litro (Km/L).</strong></td>\n</tr>\n<tr>\n<td>odometer</td>\n<td>float</td>\n<td>Último odômetro coletado no período analisado.  <br />  <br /><strong>O odômetro será expressado em quilômetros (Km)</strong></td>\n</tr>\n<tr>\n<td>totalConsumption</td>\n<td>float</td>\n<td>Total de consumo do veículo no período analisado.  <br />  <br /><strong>O total consumido será expressado em litros (L).</strong></td>\n</tr>\n<tr>\n<td>totalMileage</td>\n<td>float</td>\n<td>Distância total percorrida pelo veículo no período analisado.  <br />  <br /><strong>A distância será expressada em quilômetros (Km)</strong></td>\n</tr>\n</tbody>\n</table>\n</div><p><strong>IMPORTANTE:</strong> </p>\n<ul>\n<li><p>Os dados apresentados serão correspondentes ao período inicial e final inseridos na requisição. </p>\n</li>\n<li><p>Caso os dados de retorno estejam zerados, entre em contato com o nosso suporte através do email <a href=\"https://mailto:suporte@gobrax.com.br\">suporte@gobrax.com.br</a> para verificar o status de funcionamento da unidade eletrônica instalada no veículo.</p>\n</li>\n</ul>\n<p> </p>\n<h3 id=\"limites-e-restrições\"><strong>Limites e Restrições</strong></h3>\n<h4 id=\"limite-de-requisições\"><strong>Limite de Requisições</strong></h4>\n<p>O volume máximo de requisições permitidas é de 10/segundo. As requisições que excederem esse número serão bloqueadas pela API. O serviço irá normalizar assim que o volume retornar ao padrão determinado.</p>\n<h4 id=\"período-de-consulta\"><strong>Período de consulta</strong></h4>\n<p>O período máximo de pesquisas permitidas é de 31 dias, ou seja, o intervalo entre startDate e endDate não poderá ser maior que o determinado. Caso seja necessário consultar períodos maiores faça o particionamento da consulta em janelas de 31 em 31 dias.</p>\n","urlObject":{"protocol":"https","port":"8889","path":["api","v1","vehicle-statistics"],"host":["gateway-v3","gobrax","com","br"],"query":[{"description":{"content":"<p>(obrigatório) O campo deve receber a data e hora inicial da análise no formato: YYYY-MM-DD HH:MM:SS. A data deve ser expressada no padrão UTC.</p>\n","type":"text/plain"},"key":"startDate","value":"2021-02-10 00:00:00"},{"description":{"content":"<p>(obrigatório) O campo deve receber a data e hora final da análise no formato: YYYY-MM-DD HH:MM:SS. A data deve ser expressada no padrão UTC.</p>\n","type":"text/plain"},"key":"endDate","value":"2021-02-10 23:59:59"},{"description":{"content":"<p>(obrigatório) O campo deve receber a PLACA do veículo: ABC1234. O campo não deve conter nenhum caracter especial de separação ou espaços em branco. </p>\n","type":"text/plain"},"key":"vehicleIdentification","value":""}],"variable":[]}},"response":[{"id":"b9a4b432-6028-4d84-9f0a-80e0152ef7fc","name":"OK - Vehicle Statistics successfully retrieved for all vehicles","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway-v3.gobrax.com.br:8889/api/v1/vehicle-statistics?startDate=2021-12-12 00:00:00&endDate=2021-12-12 15:00:00","protocol":"https","host":["gateway-v3","gobrax","com","br"],"port":"8889","path":["api","v1","vehicle-statistics"],"query":[{"key":"startDate","value":"2021-12-12 00:00:00"},{"key":"endDate","value":"2021-12-12 15:00:00"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n    \"records\": [\n        {\n            \"vehicleIdentification\": \"ABC-1234\",\n            \"startDate\": \"2021-12-12 00:00:00\",\n            \"endDate\": \"2021-12-12 15:00:00\",\n            \"averageSpeed\": 60.0,\n            \"consumptionAverage\": 1.73,\n            \"odometer\": 291862.215,\n            \"totalConsumption\": 12.82,\n            \"totalMileage\": 22.17,\n            \"totalBreakingOnHighSpeed\": 0,\n            \"totalBreaking\": 9,\n        },\n        {\n            \"vehicleIdentification\": \"DDD-4444\",\n            \"startDate\": \"2021-12-12 00:00:00\",\n            \"endDate\": \"2021-12-12 15:00:00\",\n            \"averageSpeed\": 71.0,\n            \"consumptionAverage\": 1.97,\n            \"odometer\": 311202.110,\n            \"totalConsumption\": 219.35,\n            \"totalMileage\": 432.10,\n            \"totalBreakingOnHighSpeed\": 1,\n            \"totalBreaking\": 19,\n        }\n    ]\n}"},{"id":"9150111e-f095-4b50-a4d4-e92f6a476ebf","name":"OK - Vehicle Statistics successfully retrieved for a specific vehicle","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway-v3.gobrax.com.br:8889/api/v1/vehicle-statistics?startDate=2021-12-12 00:00:00&endDate=2021-12-12 15:00:00&vehicleIdentification=ABC-1234","protocol":"https","host":["gateway-v3","gobrax","com","br"],"port":"8889","path":["api","v1","vehicle-statistics"],"query":[{"key":"startDate","value":"2021-12-12 00:00:00"},{"key":"endDate","value":"2021-12-12 15:00:00"},{"key":"vehicleIdentification","value":"ABC-1234"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n    \"records\": [\n    {\n            \"vehicleIdentification\": \"ABC-1234\",\n            \"startDate\": \"2021-12-12 00:00:00\",\n            \"endDate\": \"2021-12-12 15:00:00\",\n            \"averageSpeed\": 60.0,\n            \"consumptionAverage\": 1.73,\n            \"odometer\": 291862.215,\n            \"totalConsumption\": 12.82,\n            \"totalMileage\": 22.17,\n            \"totalBreakingOnHighSpeed\": 0,\n            \"totalBreaking\": 9,\n        }\n    ]\n}"},{"id":"11e3bd7b-3687-477e-bc84-aff39301fa82","name":"Bad Request - Failed to get Vehicle statistics due missing vehicle","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway-v3.gobrax.com.br:8889/api/v1/vehicle-statistics?startDate=2021-12-10 00:00:00&endDate=2021-12-10 20:00:00&vehicleIdentification=NONE-1","protocol":"https","host":["gateway-v3","gobrax","com","br"],"port":"8889","path":["api","v1","vehicle-statistics"],"query":[{"key":"startDate","value":"2021-12-10 00:00:00"},{"key":"endDate","value":"2021-12-10 20:00:00"},{"key":"vehicleIdentification","value":"NONE-1"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"errorCode\": \"400-1\",\n    \"errorDescription\": \"Vehicle not found\"\n}"},{"id":"f4b8ffb3-2dc9-42f3-96bf-dc4b295c3c99","name":"Bad Request - Failed to get Vehicle statistics due missing start date","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway-v3.gobrax.com.br:8889/api/v1/vehicle-statistics?endDate=2021-12-15 12:00:00","protocol":"https","host":["gateway-v3","gobrax","com","br"],"port":"8889","path":["api","v1","vehicle-statistics"],"query":[{"key":"endDate","value":"2021-12-15 12:00:00"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"errorCode\": \"400-2\",\n    \"errorDescription\": \"Start Date not provided\"\n}"},{"id":"f1f0bcaa-902b-4528-a64f-581c44d8bc7f","name":"Bad Request - Failed to get Vehicle statistics due missing end date","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://gateway-v3.gobrax.com.br:8889/api/v1/vehicle-statistics?startDate=2021-12-15 12:00:00","protocol":"https","host":["gateway-v3","gobrax","com","br"],"port":"8889","path":["api","v1","vehicle-statistics"],"query":[{"key":"startDate","value":"2021-12-15 12:00:00"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n    \"errorCode\": \"400-3\",\n    \"errorDescription\": \"End Date not provided\"\n}"}],"_postman_id":"1d45d451-b2d7-4cf2-b57a-edd22308e212"}]}