Skip to content
Docs
Select language:English

/api/v1/meters/{id}/unit/preview

POST
/api/v1/meters/{id}/unit/preview
curl --request POST \
  --url https://example.com/api/v1/meters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/unit/preview \
  --header 'Content-Type: application/json' \
  --data '{ "unit": "example", "convert": true }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
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)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
unit
required
string
>= 1 characters <= 12 characters
convert
required
boolean
Examplegenerated
{
  "unit": "example",
  "convert": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
from
required
string
to
required
string
convert
required
boolean
readings
required
number
example
required
Any of:
object
before
required
string
after
required
string
offset
required
Any of:
object
before
required
string
after
required
string
maxPerDay
required
Any of:
object
before
required
string
after
required
string
replacements
required
number
schedules
required
number
Examplegenerated
{
  "from": "example",
  "to": "example",
  "convert": true,
  "readings": 1,
  "example": {
    "before": "example",
    "after": "example"
  },
  "offset": {
    "before": "example",
    "after": "example"
  },
  "maxPerDay": {
    "before": "example",
    "after": "example"
  },
  "replacements": 1,
  "schedules": 1
}