Skip to main content
Return the full detail of one data import, including its per-batch breakdown. A list_imports row plus configs: one entry per resource batch, each with its own status, progress, record counters (created / updated / deleted / skipped), error state, the connection it synced from and the first few rows it rejected or skipped, each with its reason. The rest of the rejected lines are on the page the import’s resource_url opens. Reach for it after list_imports surfaces a run whose outcome you need to explain, e.g. why an integration refresh failed or why some users did not come in. You only see imports that touched a resource type you may read. An import older than 12 months, or whose every resource type is outside your permissions, is reported as not found.

Parameters

Body

string
required
Id of the import, from list_imports.

Response

Body

string
string
Deep link to this import in the Qobra web app. Null for an import no history page lists: a legacy one whose batches name no resource type.
string
Overall status. One of: scheduled, started, finished.
string
What kicked the import off, e.g. ‘scheduled_refresh’. Null when unknown. One of: scheduled_refresh, integration_refresh, integrations_with_frequency_refresh, braqoffice_refresh, users_creation, user_integration_sync, user_file_import_refresh, user_attributes_creation, user_attribute_sync, groups_creation, data_table_refresh, data_table_settings_update, field_creation, quota_creation, quota_sync, quota_refresh, quota_settings_update.
integer
Completion from 0 to 1, averaged across the batches (1 with none).
boolean
True when a batch you can read ended in error (get_import says which).
boolean
True when a batch you can read rejected or skipped some rows (get_import lists them), even without an error.
string[]
Distinct resource types the import touched.
object
The user who triggered the import; null for a system or scheduled import.
string
string
string
object[]
One entry per resource batch. Only the batches of resource types you can read are listed.