Records

Total a column

Reductions over the records a list would return: summaries is a JSON object of field id to one of sum, avg, median, min, max, range, stdev, count, filled, empty, unique, checked, unchecked or a percentage of those.

GET/v1/tables/{tableId}/records/summary

Request

curl --request GET \
  --url 'https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/summary?summaries=<summaries>' \
  --header 'Authorization: Bearer <token>'

import json
import requests

url = "https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/summary?summaries=<summaries>"
headers = {
  "Authorization": "Bearer <token>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/summary?summaries=<summaries>", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/summary?summaries=<summaries>");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/summary?summaries=<summaries>", nil)
  req.Header.Set("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/summary?summaries=<summaries>"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://your-suite.gtable.app/your-app/v1/tables/<tableId>/records/summary?summaries=<summaries>")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {}
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}

Values come back raw and unformatted. A pair that cannot be computed exactly answers null; a field you cannot read is refused, listing the fields you can.

Requires the records:read scope. Operation records.summarise. MCP tool records_summarise. CLI, once published: gtable records summarise.

Path parameters

Name	Type	Required	Description
`tableId`	string	yes

Query parameters

Name	Type	Required	Description
`viewId`	string	no	Up to 64 characters.
`search`	string	no	Up to 200 characters.
`filter`	string	no	Up to 4000 characters.
`sorts`	string	no	Up to 1000 characters.
`where`	string	no	Up to 4000 characters.
`summaries`	string	yes	Up to 2000 characters.

Response

application/json

Success

dataRecord<string, number,string,null>required

Total a column

Path parameters

Query parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown