1. Imports
  2. Model

Imports

Model

Imports Model

The imports model represents a bulk import operation on a specific resource, detailing various phases and statuses.

object "import"
The description of the model.

id string
Unique identifier for the import.

organization_id string
Unique identifier for the organization that owns this import.

resource string
Type of resource being imported.

upload_mode sync|async
Mode of file upload.

action merge|overwrite|delete
Action to be performed on the resources in the import.

status requested|queued|processing|completed|failed|timed_out|expired
Current status of the import.

duplicate_handling ignore_all|use_first
Defaults to ignore_all. If set to use_first in the API when creating the import, the first instance of a duplicate record will be processed whereas the rest will be ignored

reason string
Reason for the final status, if applicable.

has_upload_file boolean
Indicates if an original upload file was saved.

has_errors_file boolean
Indicates if an error file was generated.

name string
Optional human-readable name for the import.

created_by string
ID of the user or API key that created the import.

column_mapping object
Optional mapping of CSV/XLSX column headers to resource field names. Keys are the resource field names and values are the corresponding column headers in the uploaded file.

phases object[]
Details of each phase in the import process. There are 7 phases in total:

  1. prevalidation - Validates uploaded data against the schema (Zod). Runs in sync or async mode depending on upload_mode.
  2. preparsing - Removes duplicate records from the validated data. Runs in sync or async mode depending on upload_mode.
  3. transforming - Injects IDs and removes ambiguities such as resources that cannot be uniquely identified. Always runs in async mode.
  4. parsing - Parses and deduplicates the transformed batch data. Always runs in async mode.
  5. validation - Validates IDs and removes invalid references. Always runs in async mode.
  6. processing - Performs the primary upsert or delete operations. Always runs in async mode.
  7. cleanup - Handles overwriting operations when applicable. Always runs in async mode.
Show Details
phases.name prevalidation|preparsing|transforming|parsing|validation|processing|cleanup
Name of the phase.
phases.mode sync|async
Processing mode of the phase.
phases.total number
Total number of items in the phase.
phases.processed number
Number of items processed in the phase.
phases.success number
Number of items successfully processed in the phase.
phases.error number
Number of items that encountered errors in the phase.

stats object
Statistics related to the import processing results.

Show Details
stats.created number
Number of resources created.
stats.updated number
Number of resources updated.
stats.deleted number
Number of resources deleted.
stats.overwritten number
Number of resources overwritten.
stats.events number
Number of events generated by the import.

created_at integer
Time in epoch seconds when this import was created.

updated_at integer
Time in epoch seconds when this import was last updated.

updated_by string
ID of the user who last updated the import.

checksum string
Checksum of the import.

_upload_url string|null
URL for uploading a file/payload via a signed URL.

_upload_csv_url string|null
URL to download the original payload as a CSV file.

_upload_json_url string|null
URL to download the original payload as a JSON file.

_errors_csv_url string|null
URL to download errors as a CSV file.

_errors_json_url string|null
URL to download errors as a JSON file.

Previous <- Imports Overview
Next Events ->