v1

latestOpenAPI 3.0.32026-08-061874701.5 MB

reports

Get report

Gets a report based on the specified ID

get/reports/{reportId}

Query parameters

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

attachments
discussions
proofs
format
objectValue - when used in combination with a level query parameter, includes the email addresses for multi-contact data
scope - adds the report's scope to the response
source - adds the Source object indicating which report the report was created from, if any
sourceSheets

exclude'linkInFromCellDetails' | 'linksOutToCellsDetails'

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

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.

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.

levelinteger

specifies whether new functionality, such as multi-contact data is returned in a backwards-compatible, text format (level=0, default), multi-contact data (level=1), or multi-picklist data (level=3).

Response

The Report that was loaded.

idnumber

The report's unique identifier.

namestring

The report's name.

totalRowCountinteger

The number of rows in the report.

effectiveAttachmentOptionsstring[]

Array of enum strings (see Attachment.attachmentType indicating the allowable attachment options for the current user and report.

ganttEnabledboolean

Indicates whether "Gantt View" is enabled.

cellImageUploadEnabledboolean

If true,images can be uploaded to the report's cells.

permalinkstring

URL that represents a direct link to this item in Smartsheet.

isSummaryReportboolean

If true, this is a sheet summary report; otherwise, it's a row report.