table-imports

Get a CSV import's status

Poll an import's progress. imported_rows climbs against total_rows while the load runs; status reaches succeeded or failed and stays there.

failed_rows is the exact count of rows that could not be written, while row_errors carries only a capped sample of them for display.

get/table-imports/{import_id}/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/table-imports/{import_id}/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

import_idstring uuid required

Response

Successful Response

created_atstring date-time required
errorstring nullable required

Why the whole job failed, if it did.

failed_rowsinteger required

Rows that could not be written: the exact count.

idstring uuid required
imported_rowsinteger required

Rows written so far.

source_filenamestring required
status'pending' | 'running' | 'succeeded' | 'failed' required

Where a CSV import has got to.

PENDING is a parsed-and-stored upload the user has not committed yet: it holds an inferred mapping and nothing else. RUNNING means the table and its columns exist and the row job is inserting. The two terminal states are absorbing: a job never leaves them.

table_idstring uuid nullable required

The table this created; null before commit.

total_rowsinteger required

Rows this import will write: the file's rows, capped by the plan and by whatever max_rows the commit asked for, or the rows its row_ranges hold.

updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.