---
title: "Total a column"
description: "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."
canonical: "https://grid82.com/docs/app-api/records/summarise"
updated: "2026-11-13"
---

# Total a column

`GET https://your-suite.grid82.app/your-app/v1/tables/{tableId}/records/summary`

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.

> **Note: Generic contract**
>
> Your own version of this operation, with your tables and the fields you can read, is in
> your app's document: `https://{suite}.grid82.app/{app}/v1/openapi.json`, behind your credential.
> [Why each person gets their own](/docs/start/studio-and-runtime#why-an-app-has-an-api-of-its-own).

Values come back raw and unformatted, with `meta.rowsLimited` as on records.list. 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: `grid82 records summarise` (`npx grid82`).

## 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. |

**Authorizations**

- `Authorization` (bearer, in header, required)

## Response

**200**: Success

- `data` (`Record<string, number,string,null>`, required)
- `meta` (`object`, required)
- `meta.rowsLimited` (`boolean`, required): True when your roles see only some of the table's rows: this answer is about those rows, not the whole table.

```json
{
  "data": {},
  "meta": {
    "rowsLimited": true
  }
}
```

**4XX**: Refused

- `error` (`object`, required)
- `error.code` (`enum<string>`, required, one of: `not_found, forbidden, unauthenticated, validation_failed, conflict, rate_limited, payment_required, not_implemented, internal`)
- `error.message` (`string`, required)
- `error.details` (`Record<string, unknown>`)

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

**Example request**

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