Get Import Progress

Prev Next
Get
/api/v1/getImportProgress

Get the progress of the import. Permission required: run-import

Changelog

Version Description
3.0.0 Added
Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Responses
200

OK

Success
{
  "key": "pending-avatars",
  "name": "Pending Avatars",
  "step": "importer_user_selection",
  "count": {
    "completed": 0,
    "total": 0
  },
  "success": true
}
Expand All
object
key
string
name
string
step
string
count
object
completed
integer
total
integer
success
boolean
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
403

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
object
success
boolean
error
string