Get task results

The SerpstatTaskProcedure.getTaskResult method brings in volume parsing results using "task_id" which was obtained with SerpstatTaskProcedure.addKeywordListFreq.

General request parameters and instructions for using Serpstat API

Request parameters
Parameter	Description	Type	Optional	Default value	Value Options
id	The identifier of a current request	string	no		1, test
method	API method name	string	no		SerpstatTaskProcedure.getTaskResult
params	Object with parameters	object	no
taskId	Task id obtained by SerpstatTaskProcedure.addKeywordListFreq	string	no		bc0a46cc-357e-4706-a674-1e8166f81fb2
page	Page number	int	yes	1	5
pageSize	Number of results per a page	int	yes	100	10

Response parameters
Parameter	Description	Type
id	Response id corresponds the request id	string
result	Object with results	json object
total	Total number of keywords for a task excluding blocked and duplicates	int
page	Ordinal number of results page	int
pageSize	Number of results found on a page	int
taskMeta	Object with parsing settings by SerpstatTaskProcedure.addKeywordListFreq	json object
typeId	Device type id: typeId=1 - desktop	int
seId	Search engine id: seId=1 - Google	int
regionId	Region or city id for Google. Region is indicated in the document (be careful this document is large and may temporarily crash the browser).	int
keywords	Array with keywords contains information for each keyword	json array of objects
keyword	Keyword with obtained volume parameters, CPC and filters	string
keyword.raw	Keyword sent for position check by user. Exclude special elements for position check (*, +, -, @, ~, !, &, \|, (, ), :, ,, ., ;)	string
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 keyword data. 3 - error sending to the queue 4 - position check error. A keyword hasn’t passed search engine issue. The detailed key thematic range is described here for Google.	string
cost	Average CPC in Google Ads for the last year in USD	int
searchVolume	Search volume for the selected region and match type	int
searchVolumeHistory	Keyword search volume history for the last 12 months. Each object contains date fields (the first day of a month in the format YYYY-MM-DDTHH:MM:SS) and value (monthly volume)	int
competition	Keyword competition in Google Ads for Google (1-100%), the keyword percentage slots for Ad in the selected region	int

Example

Request data:

{
    "id": 1,
    "method": "SerpstatTaskProcedure.getTaskResult",
    "params": {
         "taskId": "bc0a46cc-357e-4706-a674-1e8166f81fb2",
         "page": 1,
         "pageSize" : 10
     }
}

Response data:

{
    "id": "1",
    "result": {
        "total": 6,
        "page": 1,
        "pageSize": 10,
        "taskMeta": {
            "typeId": "1",
            "seId": "1",
            "regionId": "2840",
            "match": "exact"
        },
        "keywords": [
            {
                "keyword": "iphone 10",
                "keyword.raw": "iphone 10",
                "status": 2,
                "cost": 1.01,
                "searchVolume": 246000,
                "searchVolumeHistory": [
                    {
                        "date": "2020-09-01T00:00:00",
                        "value": 246000
                    },
                    {
                        "date": "2020-10-01T00:00:00",
                        "value": 301000
                    },
                    {
                        "date": "2020-11-01T00:00:00",
                        "value": 368000
                    },
                    {
                        "date": "2020-12-01T00:00:00",
                        "value": 368000
                    },
                    {
                        "date": "2021-01-01T00:00:00",
                        "value": 246000
                    },
                    {
                        "date": "2021-02-01T00:00:00",
                        "value": 201000
                    },
                    {
                        "date": "2021-03-01T00:00:00",
                        "value": 246000
                    },
                    {
                        "date": "2021-04-01T00:00:00",
                        "value": 201000
                    },
                    {
                        "date": "2021-05-01T00:00:00",
                        "value": 246000
                    },
                    {
                        "date": "2021-06-01T00:00:00",
                        "value": 201000
                    },
                    {
                        "date": "2021-07-01T00:00:00",
                        "value": 246000
                    },
                    {
                        "date": "2021-08-01T00:00:00",
                        "value": 246000
                    }
                ],
                "competition": 100
            },
            {
                "keyword": "iphone X",
                "keyword.raw": "iphone X",
                "status": 2,
                "cost": 0.94999999999999996,
                "searchVolume": 550000,
                "searchVolumeHistory": [
                    {
                        "date": "2020-09-01T00:00:00",
                        "value": 550000
                    },
                    {
                        "date": "2020-10-01T00:00:00",
                        "value": 673000
                    },
                    {
                        "date": "2020-11-01T00:00:00",
                        "value": 673000
                    },
                    {
                        "date": "2020-12-01T00:00:00",
                        "value": 673000
                    },
                    {
                        "date": "2021-01-01T00:00:00",
                        "value": 550000
                    },
                    {
                        "date": "2021-02-01T00:00:00",
                        "value": 450000
                    },
                    {
                        "date": "2021-03-01T00:00:00",
                        "value": 550000
                    },
                    {
                        "date": "2021-04-01T00:00:00",
                        "value": 550000
                    },
                    {
                        "date": "2021-05-01T00:00:00",
                        "value": 450000
                    },
                    {
                        "date": "2021-06-01T00:00:00",
                        "value": 450000
                    },
                    {
                        "date": "2021-07-01T00:00:00",
                        "value": 450000
                    },
                    {
                        "date": "2021-08-01T00:00:00",
                        "value": 673000
                    }
                ],
                "competition": 81
            }
        ]
    }
}