Skip to content
API Reference
Imports

Imports

Imports in Prism — Micro Python reference.

Reference for Python SDK 0.8.0.

Release source · Setup and client configuration

get

GET /v2/prism/{teamId}/imports/{jobId}

client.prism.imports.get(job_id, *, team_id) -> ImportGetResponse

Poll the status of an async import. Sync imports complete in the original response and don't appear here. Async jobs are retained for 7 days. Returns 404 once the job has expired.

Parameter and response types

These declarations show the request parameters and response shapes used by the methods above.

Error

Source

Set when status=failed; describes the job-level failure (not per-row).

FieldTypeRequiredDescription
codeOptional[str]No
messageOptional[str]No

ResultError

Source

FieldTypeRequiredDescription
codeOptional[str]No
messageOptional[str]No

Result

Source

FieldTypeRequiredDescription
idOptional[str]No
createdOptional[bool]No
errorOptional[ResultError]No
existingOptional[bool]NoTrue if the row matched an existing record via the dedupe key.

ImportGetResponse

Source

Status snapshot of an import job. Same shape used by the POST /import response and by GET /imports/{jobId}.

FieldTypeRequiredDescription
job_idOptional[str]NoNull for sync imports (results inlined). Set for async imports.
statusLiteral["complete", "processing", "failed"]Yes
totalintYesTotal number of rows in the import.
created_atOptional[datetime]No
errorOptional[Error]NoSet when status=failed; describes the job-level failure (not per-row).
expires_atOptional[datetime]No
failedOptional[int]No
processedOptional[int]NoRows that have been attempted (succeeded + failed).
resultsOptional[List[Result]]NoPer-row outcomes. Always present for sync imports; populated for async imports once the job reaches complete.
succeededOptional[int]No
updated_atOptional[datetime]No
micro.so