Skip to main content
POST
/
organizations
/
{orgId}
/
dataexplorer
/
meterdimensions
Retrieve the values of a Meter Dimension.
curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/dataexplorer/meterdimensions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "meterCode": "<string>",
  "dimensionName": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "attributes": [
    "<string>"
  ],
  "limit": 123
}
'
{
  "meterCode": "<string>",
  "dimensionName": "<string>",
  "dimensionValues": [
    {
      "dimensionAttribute": "<string>",
      "dimensionValue": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

UUID of the organization

Body

application/json

Data Explorer meter dimensions query.

​
meterCode
string
required

Code representing a Meter.

Minimum string length: 1
​
dimensionName
string
required

The name of a Meter dimension, for example "account".

Minimum string length: 1
​
startDate
string<date-time>
required

ISO 8601 formatted start date to filter by.

​
endDate
string<date-time>
required

ISO 8601 formatted end date to filter by.

​
attributes
string[]

Attributes to filter values by.

​
limit
integer<int32>

Limit the records returned.

Response

Returns a Meter's Dimensions from the Data Warehouse.

Response containing a Meters dimensions and values

​
meterCode
string

Code representing the Meter

​
dimensionName
string

Name representing the dimension

​
dimensionValues
object[]

Dimension values