/api/v1/things/{id}/fuel/summary

GET

const url = 'https://example.com/api/v1/things/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fuel/summary?window=5&months=6';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/things/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fuel/summary?window=5&months=6'

Parameters

Path Parameters

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Query Parameters

window

integer

default: 5 >= 1 <= 50

months

integer

default: 6 >= 1 <= 120

Responses

200

Default Response

application/json

object

byUnit

required

Array<object>

object

unit

required

string

Allowed values: L kWh gal

consumption

required

Any of:

object
null

object

perHundred

required

string

distanceUnit

required

string

fills

required

integer

>= -9007199254740991 <= 9007199254740991

from

required

string

required

string

whyNone

string

Allowed values: too_few_full_fills missed_fill mixed_units no_readings

trend

required

Array<object>

object

required

string

perHundred

required

string

pricePerUnit

Array<object>

object

unit

required

string

Allowed values: L kWh gal

currency

required

string

latest

required

string

trend

required

Array<object>

object

required

string

price

required

string

perDistance

Array<object>

object

currency

required

string

amount

required

string

distanceUnit

required

string

from

required

string

required

string

monthlyAverage

Array<object>

object

currency

required

string

amount

required

string

months

required

integer

>= -9007199254740991 <= 9007199254740991

moneyHidden

boolean

Example

{
  "byUnit": [
    {
      "unit": "L",
      "whyNone": "too_few_full_fills"
    }
  ],
  "pricePerUnit": [
    {
      "unit": "L"
    }
  ],
  "moneyHidden": true
}