Group and aggregate rows on the server (direct readers)
curl --request POST \
--url http://localhost:3000/api/v1/bases/aggregate \
--header 'Content-Type: application/json' \
--data '
{
"base": "<string>",
"agg": [
"<string>"
],
"console": "<string>",
"filter": "<string>",
"groupBy": "<string>",
"project": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/bases/aggregate"
payload = {
"base": "<string>",
"agg": ["<string>"],
"console": "<string>",
"filter": "<string>",
"groupBy": "<string>",
"project": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
base: '<string>',
agg: ['<string>'],
console: '<string>',
filter: '<string>',
groupBy: '<string>',
project: '<string>'
})
};
fetch('http://localhost:3000/api/v1/bases/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/bases/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([
'base' => '<string>',
'agg' => [
'<string>'
],
'console' => '<string>',
'filter' => '<string>',
'groupBy' => '<string>',
'project' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:3000/api/v1/bases/aggregate"
payload := strings.NewReader("{\n \"base\": \"<string>\",\n \"agg\": [\n \"<string>\"\n ],\n \"console\": \"<string>\",\n \"filter\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"project\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:3000/api/v1/bases/aggregate")
.header("Content-Type", "application/json")
.body("{\n \"base\": \"<string>\",\n \"agg\": [\n \"<string>\"\n ],\n \"console\": \"<string>\",\n \"filter\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"project\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/bases/aggregate")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"base\": \"<string>\",\n \"agg\": [\n \"<string>\"\n ],\n \"console\": \"<string>\",\n \"filter\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"project\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"baseRef": "<string>",
"consoleUrl": "<string>",
"groups": [
{
"keys": {},
"values": {}
}
],
"projectRef": "<string>",
"success": true,
"suppressedGroups": 123,
"users": {}
}bases
Group and aggregate rows on the server (direct readers)
POST
/
api
/
v1
/
bases
/
aggregate
Group and aggregate rows on the server (direct readers)
curl --request POST \
--url http://localhost:3000/api/v1/bases/aggregate \
--header 'Content-Type: application/json' \
--data '
{
"base": "<string>",
"agg": [
"<string>"
],
"console": "<string>",
"filter": "<string>",
"groupBy": "<string>",
"project": "<string>"
}
'import requests
url = "http://localhost:3000/api/v1/bases/aggregate"
payload = {
"base": "<string>",
"agg": ["<string>"],
"console": "<string>",
"filter": "<string>",
"groupBy": "<string>",
"project": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
base: '<string>',
agg: ['<string>'],
console: '<string>',
filter: '<string>',
groupBy: '<string>',
project: '<string>'
})
};
fetch('http://localhost:3000/api/v1/bases/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_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/bases/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([
'base' => '<string>',
'agg' => [
'<string>'
],
'console' => '<string>',
'filter' => '<string>',
'groupBy' => '<string>',
'project' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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 := "http://localhost:3000/api/v1/bases/aggregate"
payload := strings.NewReader("{\n \"base\": \"<string>\",\n \"agg\": [\n \"<string>\"\n ],\n \"console\": \"<string>\",\n \"filter\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"project\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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("http://localhost:3000/api/v1/bases/aggregate")
.header("Content-Type", "application/json")
.body("{\n \"base\": \"<string>\",\n \"agg\": [\n \"<string>\"\n ],\n \"console\": \"<string>\",\n \"filter\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"project\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/bases/aggregate")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"base\": \"<string>\",\n \"agg\": [\n \"<string>\"\n ],\n \"console\": \"<string>\",\n \"filter\": \"<string>\",\n \"groupBy\": \"<string>\",\n \"project\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"baseRef": "<string>",
"consoleUrl": "<string>",
"groups": [
{
"keys": {},
"values": {}
}
],
"projectRef": "<string>",
"success": true,
"suppressedGroups": 123,
"users": {}
}Body
application/json
Base id or slug
Measures: count, count::n, sum:amount, avg:amount:avg_deal (default: count)
Console base URL
Query AST filter, inline JSON or @file
Comma-separated, up to 2 keys, e.g. created_time:month,status; dates need a unit: day|week|month|quarter|year
Console project id or slug; overrides the saved Console scope