Aggregate Records

POST

bases

{databaseId}

tables

{tableId}

records

aggregate

Aggregate records

curl --request POST \
  --url https://tables.zite.com/api/v1/bases/{databaseId}/tables/{tableId}/records/aggregate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fieldId": "Amount",
  "operation": "sum",
  "filter": {
    "field": "Status",
    "equals": "Paid"
  },
  "groupBy": "Region"
}
'

import requests

url = "https://tables.zite.com/api/v1/bases/{databaseId}/tables/{tableId}/records/aggregate"

payload = {
    "fieldId": "Amount",
    "operation": "sum",
    "filter": {
        "field": "Status",
        "equals": "Paid"
    },
    "groupBy": "Region"
}
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({
    fieldId: 'Amount',
    operation: 'sum',
    filter: {field: 'Status', equals: 'Paid'},
    groupBy: 'Region'
  })
};

fetch('https://tables.zite.com/api/v1/bases/{databaseId}/tables/{tableId}/records/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://tables.zite.com/api/v1/bases/{databaseId}/tables/{tableId}/records/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([
    'fieldId' => 'Amount',
    'operation' => 'sum',
    'filter' => [
        'field' => 'Status',
        'equals' => 'Paid'
    ],
    'groupBy' => 'Region'
  ]),
  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://tables.zite.com/api/v1/bases/{databaseId}/tables/{tableId}/records/aggregate"

	payload := strings.NewReader("{\n  \"fieldId\": \"Amount\",\n  \"operation\": \"sum\",\n  \"filter\": {\n    \"field\": \"Status\",\n    \"equals\": \"Paid\"\n  },\n  \"groupBy\": \"Region\"\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://tables.zite.com/api/v1/bases/{databaseId}/tables/{tableId}/records/aggregate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fieldId\": \"Amount\",\n  \"operation\": \"sum\",\n  \"filter\": {\n    \"field\": \"Status\",\n    \"equals\": \"Paid\"\n  },\n  \"groupBy\": \"Region\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://tables.zite.com/api/v1/bases/{databaseId}/tables/{tableId}/records/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  \"fieldId\": \"Amount\",\n  \"operation\": \"sum\",\n  \"filter\": {\n    \"field\": \"Status\",\n    \"equals\": \"Paid\"\n  },\n  \"groupBy\": \"Region\"\n}"

response = http.request(request)
puts response.read_body

{
  "fieldId": "<string>",
  "result": 123,
  "groupedResults": [
    {
      "value": 123,
      "groupValue": "<string>"
    }
  ]
}

Operations

Operation	Description	Field requirement
`sum`	Total of all values	Numeric field
`avg`	Average of all values	Numeric field
`min`	Smallest value	Any field
`max`	Largest value	Any field
`count`	Number of non-empty values	Any field
`count_distinct`	Number of distinct values	Any field

fieldId (a field ID or field name) is required for every operation. sum and avg require a numeric field (number, currency, percent, rating, or duration).

Filtering

Use the optional filter to restrict which records are aggregated. It supports the same nested AND/OR logic as List Records.

Grouping

When groupBy is supplied, the response returns groupedResults (one entry per group with its value and groupValue) instead of a single result.

{
  "fieldId": "Amount",
  "operation": "sum",
  "filter": { "field": "Status", "equals": "Paid" },
  "groupBy": "Region"
}

Authorizations

Authorization

string

header

required

Enter your Zite API key. Format: Bearer <api_key>

Path Parameters

databaseId

string

required

The unique identifier of the database

tableId

string

required

The unique identifier of the table. You can also use the table name instead of the ID.

Body

application/json

fieldId

string

required

The field to aggregate, specified by field ID or field name. Required for all operations. sum and avg require a numeric field (number, currency, percent, rating, or duration).

operation

enum<string>

required

The aggregation to perform.

Available options:

sum,

avg,

min,

max,

count,

count_distinct

filter

object

Optional filter condition restricting which records are aggregated. Supports the same nested AND/OR logic as List Records.

Show child attributes

groupBy

string

Optional field (field ID or name) to group results by. When provided, groupedResults is returned instead of a single result.

Response

Aggregation result

fieldId

string

required

The field ID that was aggregated.

operation

enum<string>

required

The aggregation that was performed.

Available options:

sum,

avg,

min,

max,

count,

count_distinct

result

number | null

required

The aggregated value. Null when groupBy is used (see groupedResults) or when no rows match. sum returns 0 when no rows match.

groupedResults

object[]

Present only when groupBy is supplied. One entry per group.

Show child attributes

Aggregate records

curl --request POST \
  --url https://tables.zite.com/api/v1/bases/{databaseId}/tables/{tableId}/records/aggregate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fieldId": "Amount",
  "operation": "sum",
  "filter": {
    "field": "Status",
    "equals": "Paid"
  },
  "groupBy": "Region"
}
'

import requests

url = "https://tables.zite.com/api/v1/bases/{databaseId}/tables/{tableId}/records/aggregate"

payload = {
    "fieldId": "Amount",
    "operation": "sum",
    "filter": {
        "field": "Status",
        "equals": "Paid"
    },
    "groupBy": "Region"
}
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({
    fieldId: 'Amount',
    operation: 'sum',
    filter: {field: 'Status', equals: 'Paid'},
    groupBy: 'Region'
  })
};

fetch('https://tables.zite.com/api/v1/bases/{databaseId}/tables/{tableId}/records/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://tables.zite.com/api/v1/bases/{databaseId}/tables/{tableId}/records/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([
    'fieldId' => 'Amount',
    'operation' => 'sum',
    'filter' => [
        'field' => 'Status',
        'equals' => 'Paid'
    ],
    'groupBy' => 'Region'
  ]),
  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://tables.zite.com/api/v1/bases/{databaseId}/tables/{tableId}/records/aggregate"

	payload := strings.NewReader("{\n  \"fieldId\": \"Amount\",\n  \"operation\": \"sum\",\n  \"filter\": {\n    \"field\": \"Status\",\n    \"equals\": \"Paid\"\n  },\n  \"groupBy\": \"Region\"\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://tables.zite.com/api/v1/bases/{databaseId}/tables/{tableId}/records/aggregate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fieldId\": \"Amount\",\n  \"operation\": \"sum\",\n  \"filter\": {\n    \"field\": \"Status\",\n    \"equals\": \"Paid\"\n  },\n  \"groupBy\": \"Region\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://tables.zite.com/api/v1/bases/{databaseId}/tables/{tableId}/records/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  \"fieldId\": \"Amount\",\n  \"operation\": \"sum\",\n  \"filter\": {\n    \"field\": \"Status\",\n    \"equals\": \"Paid\"\n  },\n  \"groupBy\": \"Region\"\n}"

response = http.request(request)
puts response.read_body

{
  "fieldId": "<string>",
  "result": 123,
  "groupedResults": [
    {
      "value": 123,
      "groupValue": "<string>"
    }
  ]
}

API reference

Zite MCP (data)

Operations

Filtering

Grouping

Authorizations

Path Parameters

Body

Response

​Operations

​Filtering

​Grouping

Authorizations

Path Parameters

Body

Response

Operations

Filtering

Grouping