get https://{shopdomain}.myshoplaza.com/openapi/2022-01/data/tasks
Requires
read_dataaccess scope.
The Data Query Tasks List API allows for a paginated query of all data query tasks created by the current store. By default, it displays the first page with 20 records per page and supports up to 250 records per page.
This API is especially useful for:
- Reviewing historical data query tasks created by the store.
- Monitoring the status and details of each data query task.
- Managing large datasets efficiently with pagination.
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
page | int32 | No | Page number, default is 1. | 2 |
limit | int32 | No | Results per page, default is 20. | 15 |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
tasks[] | array | array of task object | |
tasks.query_id | string | Unique identifier for the query task. | "d6ca13c4-43d0-4293-a124-c8bde3a3fa16" |
tasks.query_status | int | Status of the query task (e.g., 2 for completed). | 2 |
tasks.query | object | ||
tasks.query.url | string | URL to access the query results. | "https://shoplazza.oss-cn-shenzhen.aliyuncs.com/..." |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "page not found" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized |