List UsageSavedQueries - m3ter Documentation

List UsageSavedQueries

cURL

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

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

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}/usage/savedqueries', 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/savedqueries",\
  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}/usage/savedqueries"

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))

}
HttpResponse<String> response = Unirest.get("https://api.m3ter.com/organizations/{orgId}/usage/savedqueries")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

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

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

Response formats

200

{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "name": "<string>",
      "usageQuery": {
        "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
      }
    }
  ],
  "nextToken": "<string>"
}

4XX

{
  "message": "<string>"
}

5XX

{
  "message": "<string>"
}

Authorizations

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

Path Parameters

Parameter Type Required Description
orgId string required UUID of the organization

Query Parameters

Parameter Type Required Description
pageSize integer required Number of UsageSavedQueries to retrieve per page; Required range: 1 <= x <= 100
nextToken string optional nextToken for multi-page retrievals
ds string[] optional Maximum array length: 200
queryType string optional

Response

200 | application/json | ListUsageSavedQueries 200 response --- | --- | --- | ---

Response attributes

Attribute Type Description
data object[]
nextToken string