List StatementDefinitions

curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/statementdefinitions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.m3ter.com/organizations/{orgId}/statementdefinitions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.m3ter.com/organizations/{orgId}/statementdefinitions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.m3ter.com/organizations/{orgId}/statementdefinitions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.m3ter.com/organizations/{orgId}/statementdefinitions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.m3ter.com/organizations/{orgId}/statementdefinitions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "name": "<string>",
      "aggregationFrequency": "DAY",
      "includePricePerUnit": true,
      "dimensions": [
        {
          "name": "<string>",
          "filter": [
            "<string>"
          ],
          "meterId": "<string>",
          "attributes": [
            "<string>"
          ]
        }
      ],
      "measures": [
        {
          "meterId": "<string>",
          "name": "<string>",
          "aggregations": [
            "SUM"
          ]
        }
      ],
      "generateSlimStatements": true,
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>"
    }
  ],
  "nextToken": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

GET

organizations

{orgId}

statementdefinitions

List StatementDefinitions

curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/statementdefinitions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.m3ter.com/organizations/{orgId}/statementdefinitions"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.m3ter.com/organizations/{orgId}/statementdefinitions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.m3ter.com/organizations/{orgId}/statementdefinitions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.m3ter.com/organizations/{orgId}/statementdefinitions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.m3ter.com/organizations/{orgId}/statementdefinitions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "name": "<string>",
      "aggregationFrequency": "DAY",
      "includePricePerUnit": true,
      "dimensions": [
        {
          "name": "<string>",
          "filter": [
            "<string>"
          ],
          "meterId": "<string>",
          "attributes": [
            "<string>"
          ]
        }
      ],
      "measures": [
        {
          "meterId": "<string>",
          "name": "<string>",
          "aggregations": [
            "SUM"
          ]
        }
      ],
      "generateSlimStatements": true,
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>"
    }
  ],
  "nextToken": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<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.

FlowAuthorization Code

Authorization URL: https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize
Token URL: https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token

FlowClient Credentials

Token URL: /oauth/token

Path Parameters

orgId

string

required

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

Query Parameters

pageSize

integer<int32>

Specifies the maximum number of StatementDefinitions to retrieve per page.

Required range: 1 <= x <= 100

nextToken

string

The nextToken for multi-page retrievals. It is used to fetch the next page of StatementDefinitions in a paginated list.

Response

Returns the list of requested StatementDefinitions

data

object[]

Show child attributes

nextToken

string

Getting Started

Endpoints

List StatementDefinitions

Authorizations

Path Parameters

Query Parameters

Response