---
title: "Total a column, as the builder"
description: "Reductions over the rows a list would return."
canonical: "https://grid82.com/docs/builder-api/data/records-summarise"
updated: "2026-11-13"
---

# Total a column, as the builder

`GET https://studio.grid82.app/v1/apps/{appId}/tables/{tableId}/records/summary`

Reductions over the rows a list would return.

`summaries` is a JSON object of field id (or exact name) to reduction; values come back raw and unformatted. An unknown field is refused, listing the table's fields.

Requires the `records:read` scope. Operation `apps.records.summarise`. MCP tool `apps_records_summarise`. CLI: `grid82 apps records summarise` (`npx grid82`).

## Path parameters

| Name      | Type   | Required | Description |
| --------- | ------ | -------- | ----------- |
| `appId`   | string | yes      |             |
| `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)

```json
{
  "data": {}
}
```

**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://studio.grid82.app/v1/apps/<appId>/tables/<tableId>/records/summary?summaries=<summaries>' \
  --header 'Authorization: Bearer <token>'
```