Get access to 30+ marketing and SEO tools. analyze competitors, keywords, and backlinks for free..
Sign in Sign Up

We use cookies to make Serpstat better. By clicking "Accept cookies", you agree to the storing of cookies on your device to enhance site navigation, analyze site usage, and assist in our marketing efforts. Learn more

Position check status within SVCS V4 (SerpstatTaskProcedure.getTaskStatus)

The SerpstatTaskProcedure.getTaskStatus method helps to obtain a position's check status with "task_id" by SerpstatTaskProcedure.addKeywordListFreq.

General request parameters and instructions for using Serpstat API

Request parameters

Parameter

Description

Type

Optional

Value Options

id

Identifier of current request

string

no

1, test

method

API method name

string

no

SerpstatTaskProcedure.getTaskStatus

params

Object with parameters

object

no

taskId

Task id (from SerpstatTaskProcedure.addKeywordListFreq)

string

no

bc0a46cc-357e-4706-a674-1e8166f81fb2

Response parameters

Parameter

Description

Type

id

Response id corresponds the request id

int

result

Object with results

json object

totalKeywords

Total number of keywords in a task flagged for position checking

int

keywordsStatusCount

Array with statuses

json object

status

Position check statuses are following:
0 - keyword is in storage ready for parsing 
1 - keyword is sent for position check (in progress)
2 - position check completed successfully, data is in place
3 - error sending to the queue
4 - position check error. A keyword hasn’t passed search engine issue. Detailed key thematic range is described here for Google and Yandex.

json object

count

Number of keywords with stated above status int

progress

Task progress. Total keywords ratio in a task to the number of keywords with 2-4 status (percentage) int

Example
Request data:
{
    "id": 1,
    "method": "SerpstatTaskProcedure.getTaskStatus",
    "params": {
         "taskId": "bc0a46cc-357e-4706-a674-1e8166f81fb2"
     }
}
Response data:
{
    "id": "1",
    "result": {
        "totalKeywords": 6,
        "keywordsStatusCount": [
            {
                "status": 2,
                "count": 6
            }
        ],
        "progress": 100
    }
}