Skip to navigation
API ReferenceTools

Get Tabular Data from Object

Beta

Read a tabular asset as a JSON data frame.

Returns columns, an optional index, and data rows (pandas “split” orientation) for an asset the caller can read: an Athena spreadsheet, a file-backed live spreadsheet (SharePoint, OneDrive, Drive, iManage), or an uploaded CSV, Excel or Parquet file. row_limit caps the rows returned, columns selects columns by name or position, sheet_name picks the sheet of an Excel file (the first by default), and separator sets the delimiter of a CSV file. Any other asset type is a 415; a file the parser cannot read is a 500 carrying the parser’s message.

Authentication

X-API-KEYstring
API Key authentication via header

Headers

X-Athena-Session-CredentialstringOptional

Query parameters

asset_idstringRequired
row_limitinteger or nullOptional
index_columninteger or nullOptional
columnslist of integers or strings or nullOptional
should be a list of strings or a list of integers
sheet_namestring or integer or nullOptionalDefaults to 0
only for excel files
separatorstring or nullOptionalDefaults to ,
only for csv files

Response

Successful Response
columnslist of nullable strings or integers or doubles
datalist of lists of nullable strings or integers or doubles
indexlist of nullable strings or integers or doubles or null

Errors

401
Unauthorized Error
404
Not Found Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
500
Internal Server Error