v1

latestOpenAPI 3.0.32026-08-061874701.5 MB

sheetSummary

Get summary fields

Returns object containing array of summary fields.

Note: For pagination guidance, refer to Pagination.

get/sheets/{sheetId}/summary/fields

Query parameters

includeAllboolean

If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified).

pagenumber

Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned.

pageSizenumber

The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request.

include'format' | 'writerInfo'

A comma-separated list of elements to include in the response.

format: includes format info for cells, rows, and summary fields
writerInfo: includes createdBy and modifiedBy attributes for rows and summary fields

exclude'displayValue' | 'image' | 'imageAltText'

A comma-separated list of elements to not include in the response.

displayValue: excludes displayValue info for cells, rows, and summary fields
image: excludes image attributes for cells and summary fields
imageAltText: excludes alt text for cells and summary fields

Response

OK.

Note: For pagination guidance, refer to Pagination.

pageNumbernumber

The current page in the full result set that the data array represents. NOTE when a page number greater than totalPages is requested, the last page is instead returned.

pageSizenumber nullable

The number of items in a page. Omitted if there is no limit to page size (and hence, all results are included). Unless otherwise specified, this defaults to 100 for most endpoints.

totalPagesnumber

The total number of pages in the full result set.

totalCountnumber

The total number of items in the full result set.

Example response

{
  "pageNumber": 1,
  "pageSize": 50,
  "totalPages": 25,
  "totalCount": 136,
  "data": [
    {
      "createdBy": {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      },
      "modifiedBy": {
        "email": "jane.doe@smartsheet.com",
        "name": "Jane Doe"
      },
      "objectValue": {
        "objectType": "CONTACT",
        "email": "john.doe@acme.com",
        "name": "John Doe",
        "imageId": "1234!_qwer!_5667zxcvQWER!_ASDF",
        "emailId": "23456789",
        "userId": "12345678",
        "lookUpName": true
      }
    }
  ]
}