Skip to main content
GET
Get a CSV import's status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

import_id
string<uuid>
required

Response

Successful Response

A CSV import's current state.

Poll this until status is terminal. imported_rows climbs as the load runs, so it doubles as a progress bar against total_rows.

columns
ImportColumnMappingSchema · object[]
required

The mapping in force.

created_at
string<date-time>
required
error
string | null
required

Why the whole job failed, if it did.

failed_rows
integer
required

Rows that could not be written — the exact count.

id
string<uuid>
required
imported_rows
integer
required

Rows written so far.

row_errors
ImportRowErrorSchema · object[]
required

A capped sample of per-row failures; failed_rows carries the full count.

source_filename
string
required
status
enum<string>
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.

Available options:
pending,
running,
succeeded,
failed
table_id
string<uuid> | null
required

The table this created; null before commit.

total_rows
integer
required

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

updated_at
string<date-time>
required