Skip to content

Import Stats (GraphQL)

Returns the current progress of an import without advancing it. Poll this between start / link / index calls to drive a progress bar.

Operation

OperationTypePurpose
adminSettingsDataTransferImportStats(id:)QueryRead progress without running a stage

Field meanings

  • processedRowsCount / invalidRowsCount / errorsCount — running counters.
  • stats.batchestotal / completed / remaining batch counts; remaining reaching 0 means the current stage has finished.
  • stats.progress — percentage (0–100) of batches completed.
  • stats.summary — created/updated/deleted record counts so far.

Quirks

  • The id argument is the stats IRI — append /stats to the import's resource path.
  • stats is returned as a raw JSON object — query it bare (no sub-selection).
  • The job's entity is exposed as code (e.g. products), not type.

Prerequisites

The example uses an illustrative id. Replace it with the stats IRI of an import that exists in your store — use the adminSettingsDataTransferImports query to discover valid ids.

Permission: settings.data_transfer.imports.view. All operations require an admin Bearer token — see Authentication.

Released under the MIT License.