Domain Classification getting a list of task results request

The DomainClassification.getTaskList method allows obtaining a list of tasks with status.

Use case: Manage Multiple Domain Classification Results Efficiently
1. Retrieve List of Completed Tasks: Use DomainClassification.getTaskList to access a comprehensive list of all domain classification tasks that have been completed.
2. Review Task Summaries: Obtain summary information for each task, including task IDs, creation dates, and statuses, allowing you to quickly assess which tasks are ready for deeper analysis.
3. Access Detailed Results for Selected Tasks: Once you've identified relevant tasks, use the task IDs to drill down into specific classification data for targeted insights.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Type

Required

Default value

Value options

method API method name string yes DomainClassification.getTaskList

id

A request id: the response contains the same id. Enter any number (number) or text (string) value

int/string

yes

Any text or number value. For example: 1, test

params

The object with parameters {...}, it lists all the following parameters and arrays [...]

array

yes

page

Page number in response

int

yes

 1

"page": "2"

 

size

Number of results per page in response

int

yes

20

"size": "20"

possible options: "20", "50", "100", "200", "500"


Response parameters

Parameter

Description

id

Response id corresponds the request id

result

Contains the answer

data

Array with data

task_id

Task identifier

status

Task status

created_at

Date and time, when the task was created

summary_info

Object with data

page

Page number

page_total

Total number of pages with results

count

Number of results on the current page

total

Total number of results


Task statuses

Code

Description

1

Pending

2

Complete

3

Error

Credits for this method are not deducted.

Example
Request data:
{
    "method": "DomainClassification.getTaskList",
    "id": 1,
    "params": {
        "page": 1,
        "size": 20
    }
}
Response data:
{
    "id": "1",
    "result": {
        "data": [
            {
                "task_id": "565892-fb87d8fa-f4c2-4b87-aa20-8ef72639625f",
                "status": "2",
                "created_at": "2024-07-31 13:36:20"
            },
            {
                "task_id": "565892-831b7e55-62ab-4165-9ea6-4260b6b73448",
                "status": "1",
                "created_at": "2024-07-31 15:25:03"
            }
        ],
        "summary_info": {
            "page": 1,
            "page_total": 1,
            "count": 20,
            "total": 2
        }
    }
}

Share this article with your friends

Are you sure?

Introducing Serpstat

Find out about the main features of the service in a convenient way for you!

Please send a request, and our specialist will offer you education options: a personal demonstration, a trial period, or materials for self-study and increasing expertise — everything for a comfortable start to work with Serpstat.

Name

Email

Phone

We are glad of your comment
I agree to Serpstat`s Privacy Policy.

Thank you, we have saved your new mailing settings.

Open support chat