Sign in
Meter

Create Meter

Create a new Meter.

When you create a Meter, you can define two types of field for usage data collection and ingest into the platform:

  • dataFields to collect raw usage data measures - numeric quantitative data values or non-numeric point data values.
  • derivedFields to derive usage data measures that are the result of applying a calculation to dataFields, customFields, or system Timestamp fields.

You can also:

  • Create customFields for a Meter, which allows you to attach custom data to the Meter as name/value pairs.
  • Create Global Meters, which are not tied to a specific Product and allow you collect to usage data that will form the basis of usage-based pricing across more than one of your Products.

IMPORTANT! - use of PII: The use of any of your end-customers' Personally Identifiable Information (PII) in m3ter is restricted to a few fields on the Account entity. Please ensure that any fields you configure for Meters, such as Data Fields or Derived Fields, do not contain any end-customer PII data. See the Introduction section above for more details.

See also:

post/organizations/{orgId}/meters

Path parameters

orgIdstring required

UUID of the organization. The Organization represents your company as a direct customer of the m3ter service.

Request body

versioninteger

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
customFieldsobject

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level, customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

productIdstring

UUID of the product the Meter belongs to. (Optional) - if left blank, the Meter is global.

groupIdstring

UUID of the group the Meter belongs to. (Optional).

namestring required

Descriptive name for the Meter.

codestring required

Code of the Meter - unique short code used to identify the Meter.

NOTE: Code has a maximum length of 80 characters and must not contain non-printable or whitespace characters (except space), and cannot start/end with whitespace.

Response

Return the created Meter

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
customFieldsobject

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level,customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

productIdstring

UUID of the Product the Meter belongs to. (Optional) - if blank, the Meter is global.

groupIdstring

UUID of the MeterGroup the Meter belongs to. (Optional).

namestring

Descriptive name for the Meter.

codestring

Code of the Meter - unique short code used to identify the Meter.

dtCreatedstring date-time

The DateTime when the meter was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when the meter was last modified (in ISO-8601 format).

createdBystring

The id of the user who created this meter.

lastModifiedBystring

The id of the user who last modified this meter.

Changes

Changed in 2 of the 10 revisions of this API.32

  • 9f9e5f3dbde721See the full diff
    • ▲

      the response property allOf[AbstractResponseWithCustomFields]/allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    • ▲

      the response property allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    • ●

      the allOf[subschema #3]/derivedFields/items/allOf[subschema #2]/calculation request property's maxLength was set to 5000

      request-property-max-length-set

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d064a12d0d9311See the full diff
    • ▲

      the allOf[AbstractRequestWithCustomFields]/allOf[subschema #2]/customFields request property type/format changed from / to object/

      request-property-type-changed

    • ●

      removed subschema #1 subschema #2 from the allOf[AbstractRequestWithCustomFields]/allOf[subschema #2]/customFields request property allOf list

      request-property-all-of-removed

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog