Retrieve a list of all conversion tasks
A REST API that returns a list of all AVIF conversions requested by the user.Request
curl -x GET
https://avif-service-api.kokoon.cloud/avif/convert/tasks?step={step}&page_size={page_size}&page_num={page_num}&start_date={yyyy-MM-dd}&end_date={yyyy-MM-dd}
-H "Authorization: <api_key>"
-H "Accept: application/json"
List of request parameters
| Parameter name | Type | Description |
|---|---|---|
| page_size | number (Optional) | The number of tasks to be returned per page. If there is page_size, page_num is also required |
| page_num | number (Optional) | page of currently requested information if page_size is present, page_num is also required |
| step | all, upload, convert, finish, error, unknown | Indicates the progress of the task. |
| start_date | string (Optional) | Indicates the time the task started. |
| end_date | string (Optional) | Indicates the time the task ended. |
Response
{
"all_count": 100,
"curr_count": 10,
"page_size": 10,
"page_num": 5,
"start_date" : "2023-01-01",
"end_date" : "2023-01-10",
"step" : "finish",
"convert_tasks" : [
{
"id": "835f24b0-90be-11ed-b598-cbb34621d6d4",
"filename": "test1.jpg",
"step": "finish"
}, {
"id": "835f24b0-90be-11ed-b598-cbb34621d6d5",
"filename": "test2.jpg",
"step": "finish"
}, {
"id": "835f24b0-90be-11ed-b598-cbb34621d6d6",
"filename": "test3.jpg",
"step": "upload"
}, {
"id": "835f24b0-90be-11ed-b598-cbb34621d6d7",
"filename": "test4.jpg",
"step": "finish"
}
]
}List of response parameters
| Response field | Type | Description |
|---|---|---|
| all_count | number | Indicates the total number of items. |
| curr_count | number | Indicates the number of current items. |
| page_size | number | Indicates the number of tasks to be returned per page. |
| page_num | number | Indicates the currently requested page. |
| convert_task.id | string | conversion id |
| convert_task.filename | string | Indicates the name of the original file. |
| convert_task.step | upload, convert, finish, unknown, error | Indicates the progress of the task. |
Table of contents