Update UsageSavedQuery - m3ter Documentation

Update UsageSavedQuery

cURL

curl --request PUT \
  --url https://api.m3ter.com/organizations/{orgId}/usage/savedqueries/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
  },
  "version": 123
}
'

Python

import requests

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

payload = {
    "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
    },
    "version": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

Fetch (JavaScript)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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
    },
    version: 123
  })
};

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

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.m3ter.com/organizations/{orgId}/usage/savedqueries/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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
    ],
    'version' => 123
  ]),
  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/savedqueries/{id}"

payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"usageQuery\": {\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      {}\n    ],\n    \"limit\": 10000\n  },\n  \"version\": 123\n}")

req, _ := http.NewRequest("PUT", 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))
}

Java

HttpResponse<String> response = Unirest.put("https://api.m3ter.com/organizations/{orgId}/usage/savedqueries/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"usageQuery\": {\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      {}\n    ],\n    \"limit\": 10000\n  },\n  \"version\": 123\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"usageQuery\": {\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      {}\n    ],\n    \"limit\": 10000\n  },\n  \"version\": 123\n}"

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

Response

200

Response Example:

{
  "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
  }
}

Authorization