Export

Get definition

{
	"kind": "export",
	"uri": string,
	"id": string,
	"createdAt": integer,
	"status": "queued" | "running" | "failed" | "cancelled" | "completed",
	"errorMessage": string | null
	"percentCompleted": numeric,
	"format": "csv" | "parquet" | "ndjson" | "avro" | "dta" | "sav",
	"size": integer,
	"fileCount": integer,
	"table": {
		...table.base
	}
}

Documentation

Fields
Get
kind	string The resource type. Will always be "export".
uri	string The fully qualified reference to this export, for use in generating calls to this API. For example, /exports/<export_id>
createdAt	integer When the export was created. Stored as milliseconds since the epoch (1970-01-01).
status	string The current status of the export. Will be one of "queued", "running", "completed", "failed", "cancelled"
errorMessage	string A user-readable message about the export. Used for conveying any additional error information.
percentCompleted	numeric An estimate of the percent completed in generating the export, between 0-100.
format	string The output format of the export. Must be one of "csv" | "parquet" | "ndjson" | "avro" | "dta" | "sav"
size	integer The total size, in bytes, of the export. If the export is made up of multiple files, size will be the sum of the size of all files. This property will be null if status is not "completed".
fileCount	integer Larger tables, when exporting in parquet or avro formats, may consist of multiple independent files. This integer express the total number of files in the export. This property will be null if status is not "completed".
table	object The base resource representation of the table associated with this export. This may be null if the table is subsequently deleted, or if future iterations of this API support exports on uploads and queries.