Query analytics data with detailed time series
1 min
POST
https://app.amberflo.io/bizlytics/query
Body Parameters
- bodybizlytics.common.AnalyticsQuery.in
- objectTypestringrequiredDescription
- aggregationcommon.aggregation.AggregationType.inDescription
- timeGroupingIntervalcommon.aggregation.AggregationInterval.inDescription
- timeRangebizlytics.common.TimeRange.inDescription
- startTimeInSecondsinteger<int64>requiredDescription
- endTimeInSecondsinteger<int64>Description
- filtermap<string, string[]>Description
- dimensionsmap<string, string[]>Description
- filterByTagsmap<string, bizlytics.common.TagFilterValues.in>Description
- groupBystring[]Description
- pagebizlytics.common.AnalyticsQuery.Page.inDescription
- numberinteger<int32>Description
- sizeinteger<int32>Description
- limitinteger<int32>
- sortbizlytics.common.AnalyticsQuery.Sort.inDescription
- isAscendingbooleanDescription
- sortBystring[]Description
- usageItemsstring[]Description
- summaryOnlybooleanDescription
- forecastbizlytics.common.ForecastOptions.inDescription
- startTimeInSecondsinteger<int64>Description
- endTimeInSecondsinteger<int64>requiredDescription
- realTimeboolean
Responses
200
- bizlytics.common.DetailedAnalyticsQueryResult.outDescription
- querybizlytics.common.AnalyticsQuery.outDescription
- objectTypestringrequiredDescription
- accountIdstring
- aggregationcommon.aggregation.AggregationType.inDescription
- timeGroupingIntervalcommon.aggregation.AggregationInterval.inDescription
- timeRangebizlytics.common.TimeRange.inDescription
- startTimeInSecondsinteger<int64>requiredDescription
- endTimeInSecondsinteger<int64>Description
- filtermap<string, string[]>Description
- dimensionsmap<string, string[]>Description
- filterByTagsmap<string, bizlytics.common.TagFilterValues.in>Description
- groupBystring[]Description
- pagebizlytics.common.AnalyticsQuery.Page.inDescription
- numberinteger<int32>Description
- sizeinteger<int32>Description
- limitinteger<int32>
- sortbizlytics.common.AnalyticsQuery.Sort.inDescription
- isAscendingbooleanDescription
- sortBystring[]Description
- usageItemsstring[]Description
- summaryOnlybooleanDescription
- forecastbizlytics.common.ForecastOptions.inDescription
- startTimeInSecondsinteger<int64>Description
- endTimeInSecondsinteger<int64>requiredDescription
- realTimeboolean
- pageMetadatabizlytics.common.PageMetadata.outDescription
- pageNumberinteger<int32>Description
- pageSizeinteger<int32>Description
- totalPagesinteger<int32>Description
- totalRecordsinteger<int32>Description
- usageItemsstring[]Description
- analyticsbizlytics.common.DetailedAnalyticsClientMeter.out[]Description
- groupbizlytics.common.group.GroupKey.outDescription
- amberfloDimensionsmap<string, string>Description
- dimensionsmap<string, string>Description
- groupValuesnumber[]Description
- valuesbizlytics.common.DetailedAnalyticsValues.out[]Description
- timeInSecondsinteger<int64>Description
- valuesnumber[]Description
- percentageChangenumber[]Description
- forecastValuesbizlytics.common.AnalyticsValues.out[]Description
- timeInSecondsinteger<int64>Description
- valuesnumber[]Description
- timeGroupsInSecondsinteger[]Description
400
401
403
404
500
curl
curl --request POST \
--url https://app.amberflo.io/bizlytics/query \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"objectType": "",
"timeRange": {
"startTimeInSeconds": 0
},
"forecast": {
"endTimeInSeconds": 0
}
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"objectType": "",
"timeRange": {
"startTimeInSeconds": 0
},
"forecast": {
"endTimeInSeconds": 0
}
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://app.amberflo.io/bizlytics/query", 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/bizlytics/query")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"objectType": "",
"timeRange": {
"startTimeInSeconds": 0
},
"forecast": {
"endTimeInSeconds": 0
}
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://app.amberflo.io/bizlytics/query"
payload = json.dumps({
"objectType": "",
"timeRange": {
"startTimeInSeconds": 0
},
"forecast": {
"endTimeInSeconds": 0
}
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Successfully retrieved detailed analytics data with complete time series
{
"query": {
"objectType": "",
"accountId": "",
"aggregation": "",
"timeGroupingInterval": "",
"timeRange": {
"startTimeInSeconds": "",
"endTimeInSeconds": ""
},
"filter": "",
"dimensions": "",
"filterByTags": "",
"groupBy": [
""
],
"page": {
"number": "",
"size": ""
},
"limit": "",
"sort": {
"isAscending": false,
"sortBy": [
""
]
},
"usageItems": [
""
],
"summaryOnly": false,
"forecast": {
"startTimeInSeconds": "",
"endTimeInSeconds": ""
},
"realTime": false
},
"pageMetadata": {
"pageNumber": "",
"pageSize": "",
"totalPages": "",
"totalRecords": ""
},
"usageItems": [
""
],
"analytics": [
{
"group": {
"amberfloDimensions": "",
"dimensions": ""
},
"groupValues": [
0
],
"values": [
{
"timeInSeconds": "",
"values": [
0
],
"percentageChange": [
0
]
}
],
"forecastValues": [
{
"timeInSeconds": "",
"values": [
0
]
}
]
}
],
"timeGroupsInSeconds": [
0
]
}400
// Invalid query parameters or unsupported aggregation type
401
// Authentication required or invalid API key
403
// Insufficient permissions to access analytics data
404
// Requested meter or analytics object not found
500
// Internal server error occurred while processing the query