helpers

Load a preview of a csv file

Changed on
get/w/{workspace}/job_helpers/load_csv_preview/{path}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/w/{workspace}/job_helpers/load_csv_preview/{path}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

workspacestring required
pathstring required

Query parameters

offsetnumber
limitnumber
sort_colstring
sort_descboolean
search_colstring
search_termstring
storagestring
s3_resource_pathstring

Read the file from this object storage resource instead of the workspace storage.

csv_separatorstring
csv_has_headerboolean

Whether the first CSV line names the columns. Defaults to true.

filtersstring

JSON object, column name to filter. A number column takes an optional comparison operator and a number (>=10), a boolean column a boolean, and any other column a case-insensitive substring, or =value for an exact match. A search_term without a search_col matches any column, case-insensitively.

Response

Csv Preview: columns, column_types (Arrow type names), rows, and the csv_separator the file was read with, guessed from its first bytes when none is given. A .jsonl or .ndjson file is read as newline-delimited JSON.

Changes

  • d75a03eeb6a5Revision changes
    • info

      added the new optional query request parameter csv_has_header

    • info

      added the new optional query request parameter filters

    • info

      added the new optional query request parameter s3_resource_path