Orgs Views
Aggregate view records
Compute count/sum/avg/min/max over the records of a view, optionally grouped, windowed and filtered. Honors the view filter on top of the spec filter.
POST
/
orgs
/
{org_id}
/
views
/
{view_id}
/
aggregate
Aggregate view records
curl --request POST \
--url https://api.useinvent.com/orgs/{org_id}/views/{view_id}/aggregate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metric": {
"field_key": "<string>"
},
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"compare": "previous_period",
"limit": 25
}
'import requests
url = "https://api.useinvent.com/orgs/{org_id}/views/{view_id}/aggregate"
payload = {
"metric": { "field_key": "<string>" },
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"compare": "previous_period",
"limit": 25
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metric: {field_key: '<string>'},
filter: {type: 'rule', key: '<string>', value: '<unknown>'},
compare: 'previous_period',
limit: 25
})
};
fetch('https://api.useinvent.com/orgs/{org_id}/views/{view_id}/aggregate', 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.useinvent.com/orgs/{org_id}/views/{view_id}/aggregate",
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([
'metric' => [
'field_key' => '<string>'
],
'filter' => [
'type' => 'rule',
'key' => '<string>',
'value' => '<unknown>'
],
'compare' => 'previous_period',
'limit' => 25
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useinvent.com/orgs/{org_id}/views/{view_id}/aggregate"
payload := strings.NewReader("{\n \"metric\": {\n \"field_key\": \"<string>\"\n },\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"compare\": \"previous_period\",\n \"limit\": 25\n}")
req, _ := http.NewRequest("POST", 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))
}HttpResponse<String> response = Unirest.post("https://api.useinvent.com/orgs/{org_id}/views/{view_id}/aggregate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"metric\": {\n \"field_key\": \"<string>\"\n },\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"compare\": \"previous_period\",\n \"limit\": 25\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useinvent.com/orgs/{org_id}/views/{view_id}/aggregate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metric\": {\n \"field_key\": \"<string>\"\n },\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"compare\": \"previous_period\",\n \"limit\": 25\n}"
response = http.request(request)
puts response.read_body{
"kind": "value",
"value": 123,
"previous": 123
}Authorizations
Bearer token authentication using your API key
Body
application/jsonmultipart/form-data
Was this page helpful?
⌘I
Aggregate view records
curl --request POST \
--url https://api.useinvent.com/orgs/{org_id}/views/{view_id}/aggregate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"metric": {
"field_key": "<string>"
},
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"compare": "previous_period",
"limit": 25
}
'import requests
url = "https://api.useinvent.com/orgs/{org_id}/views/{view_id}/aggregate"
payload = {
"metric": { "field_key": "<string>" },
"filter": {
"type": "rule",
"key": "<string>",
"value": "<unknown>"
},
"compare": "previous_period",
"limit": 25
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
metric: {field_key: '<string>'},
filter: {type: 'rule', key: '<string>', value: '<unknown>'},
compare: 'previous_period',
limit: 25
})
};
fetch('https://api.useinvent.com/orgs/{org_id}/views/{view_id}/aggregate', 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.useinvent.com/orgs/{org_id}/views/{view_id}/aggregate",
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([
'metric' => [
'field_key' => '<string>'
],
'filter' => [
'type' => 'rule',
'key' => '<string>',
'value' => '<unknown>'
],
'compare' => 'previous_period',
'limit' => 25
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.useinvent.com/orgs/{org_id}/views/{view_id}/aggregate"
payload := strings.NewReader("{\n \"metric\": {\n \"field_key\": \"<string>\"\n },\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"compare\": \"previous_period\",\n \"limit\": 25\n}")
req, _ := http.NewRequest("POST", 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))
}HttpResponse<String> response = Unirest.post("https://api.useinvent.com/orgs/{org_id}/views/{view_id}/aggregate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"metric\": {\n \"field_key\": \"<string>\"\n },\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"compare\": \"previous_period\",\n \"limit\": 25\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useinvent.com/orgs/{org_id}/views/{view_id}/aggregate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"metric\": {\n \"field_key\": \"<string>\"\n },\n \"filter\": {\n \"type\": \"rule\",\n \"key\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"compare\": \"previous_period\",\n \"limit\": 25\n}"
response = http.request(request)
puts response.read_body{
"kind": "value",
"value": 123,
"previous": 123
}