Get task progress

Get realtime progress of the given task. Note that not all phases and all task types support getting progress. Empty response will be returned if there's no available progress info.

The response is a map between progress type and the actual progress. Common progress types are:

Progress Type	Description
`upload_single_<index>`	Uploaded/Total bytes of a single uplaod thread.
`upload_count`	Count of processed/total files.
`upload`	Uploaded/Total bytes of all files to be processed in this step.
`imported`	Imported/Total files.
`indexed`	Used in importing file tasks, indicating indexed files.

Only tasks owned by current authenticated user is available. For admin users, all tasks are available in this method.

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Responses

🟢200Success

application/json

Body

data

object

required

Map of progress type and the progress content.

Additional properties

object

optional

code

integer

required

Response code.
0 - Success.

Default:

Example:

msg

string

optional

Human readable error message (if any).

Example

{
    "data": {
        "upload_count": {
            "total": 34,
            "current": 25
        },
        "upload": {
            "total": 12836332,
            "current": 16889
        }
    },
    "code": 0,
    "msg": ""
}

🟢200No available progress

Request

Request samples

Responses