Domain Classification getting task results request
The DomainClassification.getTask method allows obtaining a result of a task.
Use case: Retrieve and Utilize Domain Classification Results
1. Access Classification Task Results: After creating a domain classification task, retrieve its results using DomainClassification.getTask.
2. Download Classification Data: Use the API request to obtain detailed data on the classified domains, including insights into industry.
3. Incorporate Data into Your Strategy: Use the refined classification data to enhance your competitive analysis, target relevant industries, or adjust your keyword list based on domain relevance.
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.getTask | |
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 |
|
|
task_id |
| int | yes |
| Task id number. For example: bc04446cc-322e-4706-a674-1eea6f81fb2 |
Response parameters | |
Parameter | Description |
id | Response id corresponds the request id |
result | Contains the answer |
task_id | Task identifier |
data | Array with data |
domain | Analyzed domain |
categories_names | Name of the determined domain's category. Unknown - in case we could not determine the domain's category Unreachable - domain has already been submitted for categorization and the information is currently stored in the cache |
categories_confidence | Numeric value that reflects the degree of the system's confidence that the domain is correctly classified into a certain category. The higher the value of categories_confidence, the more confident the algorithm is that the domain belongs to this particular category. For Unknown domains categories_confidence will be always = 1 |
status | Task status |
created_at | Date and time, when the task was created |
Task statuses | |
Code | Description |
1 | Pending |
2 | Complete |
3 | Error |
Credits for this method are not deducted.
{
"method": "DomainClassification.getTask",
"id": 1,
"params": {
"task_id": "565892-fb87d8fa-f4c2-4b87-aa20-8ef72639625f"
}
}
{
"id": "1",
"result": {
"task_id": "565892-fb87d8fa-f4c2-4b87-aa20-8ef72639625f",
"data": [
{
"domain": "facebook.com",
"categories_names": [
"\/Online Communities\/Social Networks"
],
"categories_confidence": [
0.91368252038956
]
},
{
"domain": "serpstat.com",
"categories_names": [
"\/Internet \u0026 Telecom\/Web Services\/Search Engine Optimization \u0026 Marketing",
"\/Internet \u0026 Telecom\/Web Services\/Web Stats \u0026 Analytics",
"\/Business \u0026 Industrial\/Advertising \u0026 Marketing\/Marketing",
"\/Computers \u0026 Electronics\/Software\/Business \u0026 Productivity Software",
"\/Internet \u0026 Telecom\/Other"
],
"categories_confidence": [
0.95500206947327,
0.93769299983978,
0.38967737555504,
0.18042197823524,
0.12408629059792
]
}
],
"status": "2",
"created_at": "2024-07-31 13:36:20"
}
}