Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Meters

Create new meter

Endpoint used to create a new meter. Pay attention to the measurementType field as it has a significant impact on the behavior of your meter.

post/meters

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

namestring required

Name of the meters

descriptionstring nullable

Description of the meter

measurementType'MANUAL' | 'IOT_DEVICE' | 'AUTOMATED_SENSOR'

Represents the Type of meter. <br><br><code>Manual</code>: They are made to be used in the MaintainX app and to retain manually entered values and are limited to 10 distinct readings creation requests per 24 hours over REST API. Batched readings requests only count as one toward the rate limit. <br><br><code>Automated</code>: (Enterprise Plan) Automated meters store high frequency readings sent from integrations and have normal rate limiting. <br><br><code>IoT Device</code>: IoT Device meters are deprecated and should no longer be used in the future. Creating an IoT Device meter will mimic automated meters in terms of behavior to avoid breaking changes.

unitstring required

Measurement unit for the readings. Any string is accepted. However, if applicable, we recommed you to use the following units as it may carry extra functionality: <br><ul> <li>Distance: <ul> <li><code>Miles</code></li><li><code>Feet</code></li><li><code>Inches</code></li><li><code>Kilometers</code></li><li><code>Meters</code></li><li><code>Centimeters</code></li><li><code>Millimeters</code></li> </ul> </li> <li>Volume: <ul> <li><code>Gallons</code></li><li><code>Liters</code></li><li><code>Milliliters</code></li><li><code>Cubic Meters</code></li> </ul> </li> <li>Temperature: <ul> <li><code>Celsius</code></li><li><code>Fahrenheit</code></li><li><code>Kelvin</code></li> </ul> </li> <li>Other: <ul> <li><code>Hours</code></li><li><code>Cycles</code></li><li><code>PSI</code></li><li><code>Kilograms</code></li><li><code>Grams</code></li><li><code>dBm</code></li><li><code>Nm</code></li> </ul> </li> <li>Velocity: <ul> <li><code>MetersPerSecond</code></li><li><code>InchesPerSecond</code></li><li><code>MillimetersPerSecond</code></li> </ul> </li> <li>Acceleration: <ul> <li><code>G-Force</code></li><li><code>MetersPerSecondSquared</code></li><li><code>FeetPerSecondSquared</code></li> </ul> </li> <li>Electrical: <ul> <li><code>Volts</code></li><li><code>Amps</code></li> </ul> </li> </ul>

assetIdinteger nullable

Global ID of the asset tied to the meter

locationIdinteger nullable

Global ID of the location tied to the meter

Example request

{
  "description": "This meter is used for monitoring the temperature of the boiler",
  "measurementType": "AUTOMATED_SENSOR",
  "unit": "Celsius",
  "assetId": 123,
  "locationId": 123
}

Response

Successfully created meter

idnumber required

Global ID of the meter.

Example response

{
  "id": 123
}