SVCS results V4 (SerpstatTaskProcedure.getTaskResultFreq)
SerpstatTaskProcedure.getTaskResultFreq — this method brings in frequency parsing results using “task_id” which was obtained by SerpstatTaskProcedure.addKeywordListFreq
Request parameters:
|
Parameter |
Description |
Type |
Optional |
Default value |
Value Options |
|
task Id |
Task id obtained by SerpstatTaskProcedure.addKeywordListFreq |
string |
no |
352ab0be-b8a4-4966-8d16-f9137cb93c23 |
|
|
page |
Page number |
int |
yes |
1 |
5 |
|
pageSize |
Number of results per a page |
int |
yes |
100 |
|
Parameter |
Description |
Type |
|
id |
Query id used to process asynchronous queries |
int |
|
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 |
|
task_meta |
Parsing setting id |
json object |
|
keywords |
Array of keywords with information for each keyword | json array of objects |
|
keyword |
Keyword with obtained frequency 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 https://support.google.com/adspolicy/answer/6008942?hl=ru |
string |
|
searchVolume |
Search volume for the selected region and match type | int |
|
searchVolumeHistory |
Keyword search volume history for the last 12 month. Each object contains date fields (the first day of a month in the format YYYY-MM-DDTHH:MM:SS) and value (monthly volume) | int |
|
cost |
Average CPC in Google Ads for the last year in USD (Min cost of placement in Yandex premium block) | int |
|
competition |
Keyword competition in Google Ads for Google (1-100), the keyword percentage slots for Ad in the selected region | int |
|
taskMeta |
Object with parsing settings by SerpstatTaskProcedure.addKeywordListFreq | json object |
|
se Id |
Search engine id: seId=1 - Google seId=2 - Yandex |
int |
|
type Id |
Device type id: typeId=1 - Desktop typeId=2 - Mobile typeId=2 - Yandex only. Position check for Google only typeId=1, regardless the specified parameter. |
int |
|
region Id |
Region or city id for Google and Yandex.Region is indicated in the document. Be careful this document is large and may temporarily crash the browser. https://docs.google.com/spreadsheets/d/1LUDtm-L1qWMVpmWuN-nvDyYFfQtfiXUh5LIHE8sjs0k/edit#gid\u003d1732572784 | int |
|
match Id |
Match type id. Yandex only. Google position check only match “extra” extra - cares about both word form and order. Example: “[!buy!an elephant!in instalments]” exact - doesn’t care about word order but does care about word form. Example: “!buy! an elephant! in instalments!” phrase - anything that contains these words in a different order or word form will do. Example: “to buy an elephant in instalments” wide - wide match with the fixed word form. Example: buy an elephant in instalments” wide-fixed - wide match with the fixed word form. Example: !buy!an elephant! in instalments! |
string |