Get a list of meters
1 min
GET
https://app.amberflo.io/customer-portal/meter
Query Parameters
- labelstringDescription
- meterApiNamestringDescription
- aggregationstringDescription
- meterTypestringDescription
- eventTypestringDescription
- measurementTypestringDescription
- sessionTokenstringrequiredDescription
Responses
200
- meter-list-responseExample
[ { "id": "meter1", "label": "ApiCalls1", "meterApiName": "ApiCalls1", "meterType": "sum_of_all_usage", "description": "ApiCalls1 metric", "dimensions": [ "region1", "customerA" ], "lockingStatus": "open", "createTime": 1620363790970, "updateTime": 1626885651245 }, { "id": "meter2", "label": "ApiCalls2", "meterApiName": "ApiCalls2", "meterType": "sum_of_all_usage", "description": "ApiCalls2 metric", "dimensions": [ "region2", "customerB" ], "lockingStatus": "open", "createTime": 1623255947408, "updateTime": 1623255947408 } ]- idstringDescription
- labelstringDescriptionDefaultApi Calls
- meterApiNamestringDescriptionDefaultApiCalls
- meterTypestring<sum_of_all_usage | max_usage | running_total | event_duration | unique_count>DescriptionDefaultsum_of_all_usage
- descriptionstringDescriptionDefaultApiCalls metric
- dimensionsobject[]DescriptionDefaultregion,customer_type
- uniqueDimensionstringDescription
- eventIdDimensionstringDescription
- lockingStatusstring<open | close_to_changes | close_to_deletion | deprecated>DescriptionDefaultopen
- useInBillingbooleanDescriptionDefaultfalse
- squashSumMeterbooleanDescriptionDefaultfalse
- createTimeintegerDescription
- updateTimeintegerDescription
curl
curl --request GET \
--url 'https://app.amberflo.io/customer-portal/meter?sessionToken=string' \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://app.amberflo.io/customer-portal/meter?sessionToken=string", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://app.amberflo.io/customer-portal/meter?sessionToken=string")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://app.amberflo.io/customer-portal/meter?sessionToken=string"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Successful response
[
{
"id": "",
"label": "",
"meterApiName": "",
"meterType": "",
"description": "",
"dimensions": [
{}
],
"uniqueDimension": "",
"eventIdDimension": "",
"lockingStatus": "",
"useInBilling": false,
"squashSumMeter": false,
"createTime": 0,
"updateTime": 0
}
]