Skip to main content
GET
Read an attached file column's value distribution

Authorizations

X-API-Key
string
header
required

Path Parameters

attachment_id
string<uuid>
required
source_index
integer
required

Query Parameters

sheet
string | null

A workbook sheet by name, matched without case when no sheet has exactly that name; omit for the attached sheet.

Required string length: 1 - 255
header_row
integer
default:0

The row holding the column names under a title, numbered as a page of the file's rows numbers them; the column is named from it and counted over the rows below. 0 keeps the first row.

Required range: x >= 0

Response

Successful Response

How one column of a file's values are spread across its rows: a chart, computed on read.

Counts cover every data row of the file's selected sheet (or a CSV), before any import row cap. Whitespace-only cells are empty; nonempty values are counted as the file spells them, uncoerced. The raw values themselves are a page of their own, at …/columns/{source_index}/values/.

distinct_count
integer
required

Distinct nonempty values.

empty_count
integer
required

Rows whose cell is empty or whitespace-only.

name
string
required

The column's name, from the header row.

other_count
integer
required

Nonempty rows holding a value outside values.

total_count
integer
required

Every data row of the sheet, empty cells included.

values
FileValueFrequencySchema · object[]
required

The 20 most common values, most common first, ties in file order.