Query and filter usage data - m3ter Documentation

Query and filter usage data

cURL

curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/usage/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "meterIds": [
    "<string>"
  ],
  "accountIds": [
    "<string>"
  ],
  "dimensionFilters": [
    {
      "meterId": "<string>",
      "fieldCode": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "aggregations": [
    {
      "meterId": "<string>",
      "fieldCode": "<string>",
      "fieldType": "<unknown>",
      "function": "<unknown>"
    }
  ],
  "groups": [
    {}
  ],
  "limit": 10000
}
'

Python

import requests

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

payload = {
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "meterIds": ["<string>"],
    "accountIds": ["<string>"],
    "dimensionFilters": [
        {
            "meterId": "<string>",
            "fieldCode": "<string>",
            "values": ["<string>"]
        }
    ],
    "aggregations": [
        {
            "meterId": "<string>",
            "fieldCode": "<string>",
            "fieldType": "<unknown>",
            "function": "<unknown>"
        }
    ],
    "groups": [{}],
    "limit": 10000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

JavaScript (Fetch API)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    startDate: '2023-11-07T05:31:56Z',
    endDate: '2023-11-07T05:31:56Z',
    meterIds: ['<string>'],
    accountIds: ['<string>'],
    dimensionFilters: [{meterId: '<string>', fieldCode: '<string>', values: ['<string>']}],
    aggregations: [
      {meterId: '<string>', fieldCode: '<string>', fieldType: '<unknown>', function: '<unknown>'}
    ],
    groups: [{}],
    limit: 10000
  })
};

fetch('https://api.m3ter.com/organizations/{orgId}/usage/query', 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}/usage/query",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'startDate' => '2023-11-07T05:31:56Z',
    'endDate' => '2023-11-07T05:31:56Z',
    'meterIds' => ['<string>'],
    'accountIds' => ['<string>'],
    'dimensionFilters' => [[
       'meterId' => '<string>',
       'fieldCode' => '<string>',
       'values' => ['<string>']
    ]],
    'aggregations' => [[
       'meterId' => '<string>',
       'fieldCode' => '<string>',
       'fieldType' => '<unknown>',
       'function' => '<unknown>'
    ]],
    'groups' => [[]],
    'limit' => 10000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

Go

package main

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

func main() {

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

payload := strings.NewReader("{\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"meterIds\": [\n    \"<string>\"\n  ],\n  \"accountIds\": [\n    \"<string>\"\n  ],\n  \"dimensionFilters\": [\n    {\n      \"meterId\": \"<string>\",\n      \"fieldCode\": \"<string>\",\n      \"values\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"aggregations\": [\n    {\n      \"meterId\": \"<string>\",\n      \"fieldCode\": \"<string>\",\n      \"fieldType\": \"<unknown>\",\n      \"function\": \"<unknown>\"\n    }\n  ],\n  \"groups\": [{}],\n  \"limit\": 10000\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
    req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))
}

Example Response

{
  "data": [{}],
  "hasMoreData": true
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization string header required. m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

Path Parameters

Body