Get meter usage analytics
curl --request POST \
--url https://api.tirdad.ai/v1/meter-usage/analytics \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"end_time": "2024-02-01T00:00:00Z",
"external_customer_id": "cust_123",
"meter_ids": [
"mtr_abc",
"mtr_def"
],
"start_time": "2024-01-01T00:00:00Z",
"billing_anchor": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.tirdad.ai/v1/meter-usage/analytics"
payload = {
"end_time": "2024-02-01T00:00:00Z",
"external_customer_id": "cust_123",
"meter_ids": ["mtr_abc", "mtr_def"],
"start_time": "2024-01-01T00:00:00Z",
"billing_anchor": "2023-11-07T05:31:56Z"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
end_time: '2024-02-01T00:00:00Z',
external_customer_id: 'cust_123',
meter_ids: ['mtr_abc', 'mtr_def'],
start_time: '2024-01-01T00:00:00Z',
billing_anchor: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.tirdad.ai/v1/meter-usage/analytics', 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.tirdad.ai/v1/meter-usage/analytics",
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([
'end_time' => '2024-02-01T00:00:00Z',
'external_customer_id' => 'cust_123',
'meter_ids' => [
'mtr_abc',
'mtr_def'
],
'start_time' => '2024-01-01T00:00:00Z',
'billing_anchor' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.tirdad.ai/v1/meter-usage/analytics"
payload := strings.NewReader("{\n \"end_time\": \"2024-02-01T00:00:00Z\",\n \"external_customer_id\": \"cust_123\",\n \"meter_ids\": [\n \"mtr_abc\",\n \"mtr_def\"\n ],\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"billing_anchor\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://api.tirdad.ai/v1/meter-usage/analytics")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"end_time\": \"2024-02-01T00:00:00Z\",\n \"external_customer_id\": \"cust_123\",\n \"meter_ids\": [\n \"mtr_abc\",\n \"mtr_def\"\n ],\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"billing_anchor\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tirdad.ai/v1/meter-usage/analytics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"end_time\": \"2024-02-01T00:00:00Z\",\n \"external_customer_id\": \"cust_123\",\n \"meter_ids\": [\n \"mtr_abc\",\n \"mtr_def\"\n ],\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"billing_anchor\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"event_count": 42,
"meter_id": "mtr_abc",
"points": [
{
"event_count": 10,
"timestamp": "2024-01-01T00:00:00Z",
"value": "100.0000"
}
],
"total_value": "1234.5678"
}
]
}{
"details": {},
"http_status_code": 123,
"message": "<string>"
}{
"details": {},
"http_status_code": 123,
"message": "<string>"
}MeterUsage
Get meter usage analytics
Query aggregated usage from meter_usage table for multiple meters
POST
/
meter-usage
/
analytics
Get meter usage analytics
curl --request POST \
--url https://api.tirdad.ai/v1/meter-usage/analytics \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"end_time": "2024-02-01T00:00:00Z",
"external_customer_id": "cust_123",
"meter_ids": [
"mtr_abc",
"mtr_def"
],
"start_time": "2024-01-01T00:00:00Z",
"billing_anchor": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.tirdad.ai/v1/meter-usage/analytics"
payload = {
"end_time": "2024-02-01T00:00:00Z",
"external_customer_id": "cust_123",
"meter_ids": ["mtr_abc", "mtr_def"],
"start_time": "2024-01-01T00:00:00Z",
"billing_anchor": "2023-11-07T05:31:56Z"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
end_time: '2024-02-01T00:00:00Z',
external_customer_id: 'cust_123',
meter_ids: ['mtr_abc', 'mtr_def'],
start_time: '2024-01-01T00:00:00Z',
billing_anchor: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.tirdad.ai/v1/meter-usage/analytics', 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.tirdad.ai/v1/meter-usage/analytics",
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([
'end_time' => '2024-02-01T00:00:00Z',
'external_customer_id' => 'cust_123',
'meter_ids' => [
'mtr_abc',
'mtr_def'
],
'start_time' => '2024-01-01T00:00:00Z',
'billing_anchor' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.tirdad.ai/v1/meter-usage/analytics"
payload := strings.NewReader("{\n \"end_time\": \"2024-02-01T00:00:00Z\",\n \"external_customer_id\": \"cust_123\",\n \"meter_ids\": [\n \"mtr_abc\",\n \"mtr_def\"\n ],\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"billing_anchor\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://api.tirdad.ai/v1/meter-usage/analytics")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"end_time\": \"2024-02-01T00:00:00Z\",\n \"external_customer_id\": \"cust_123\",\n \"meter_ids\": [\n \"mtr_abc\",\n \"mtr_def\"\n ],\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"billing_anchor\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tirdad.ai/v1/meter-usage/analytics")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"end_time\": \"2024-02-01T00:00:00Z\",\n \"external_customer_id\": \"cust_123\",\n \"meter_ids\": [\n \"mtr_abc\",\n \"mtr_def\"\n ],\n \"start_time\": \"2024-01-01T00:00:00Z\",\n \"billing_anchor\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"event_count": 42,
"meter_id": "mtr_abc",
"points": [
{
"event_count": 10,
"timestamp": "2024-01-01T00:00:00Z",
"value": "100.0000"
}
],
"total_value": "1234.5678"
}
]
}{
"details": {},
"http_status_code": 123,
"message": "<string>"
}{
"details": {},
"http_status_code": 123,
"message": "<string>"
}Authorizations
Enter your API key in the format x-api-key <api-key>*
Body
application/json
Analytics parameters
Available options:
COUNT, SUM, AVG, COUNT_UNIQUE, LATEST, SUM_WITH_MULTIPLIER, MAX, WEIGHTED_SUM Example:
"2024-02-01T00:00:00Z"
Example:
"cust_123"
Minimum array length:
1Example:
["mtr_abc", "mtr_def"]
Example:
"2024-01-01T00:00:00Z"
Available options:
MONTH, MINUTE, 15MIN, 30MIN, HOUR, 3HOUR, 6HOUR, 12HOUR, DAY, WEEK, MONTH Response
OK
Show child attributes
Show child attributes
⌘I