3. Meters

3.1. Object Model

A meter groups a series of related metrics. Each metric is backed by a timeseries. Meter level attributes are:

• A set of identifiers.
• A set of metrics.

Identifier level attributes are:

• The identification scheme, such as mpan.
• The identifier in the scheme.

Metric level attributes are:

• The kind of metric or its unit
• A label
• A timeseries URI

The meter API supports the creation, update and retrieval of this data.

3.2. Operations

3.2.1. List Meters

List all the meters in the database. The actual list will be filtered to only return meters for which the user has read permissions.

• Permission: list:meters
• Verb: GET
• Path: /meters

3.2.2. Create Meter

Create a new meter.

• Permission: create:meters
• Verb: POST
• Path: /meters

3.2.3. Read Meter

Read the meter level attributes of the given meter.

• Permissions: read:meters:{id}, read:meters:tag={label}
• Verb: GET
• Path: /meters/{id}

3.2.4. Update Meter

Update the meter level attributes of the given meter.

• Permissions: update:meters:{id}, update:meters:tag={label}
• Verb: PUT
• Path: /meters/{id}

3.2.5. Delete Meter

Delete a meter and all associated records.

• Permissions: delete:meters:{id}, delete:meters:tag={label}
• Verb: DELETE
• Path: /meters/{id}