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

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

By using the website, you agree to our Privacy policy

Sign in Sign Up

Search Volume Crawling Service (SVCS) V4

7.1. Sending keywords to SVCS (SerpstatTaskProcedure.addKeywordListFreq)

SerpstatTaskProcedure.addKeywordListFreq — this method sends keywords to frequency parsing and returns a unique task key to be used for SerpstatTaskProcedure.getTaskResultFreq to get parsing results. Keywords must be transferred as an array.

Request parameters:

Parameter

Description

Type

Optional

Default value

Value Options

keywords

Keywords. Max amount  - 50 000

array

no

se id

Search base

string

yes

1

1 - google

2 - yandex

type Id

Device id type

int

yes

 1

1 - desktop

2 - mobile

region Id

Region or city id for Google or Yandex Region is indicated in the document

int

no

 

match

Type match id (Yandex only)

string

yes

exact

exactdoesn’t care about word order but does care about word form. Example: “!buy in instalments!”

extracares about both word form and order. Example: “[!buy!in instalments]”

phraseanything that contains these words in a different order or word form will do. Example: “to buy an elephant in instalments”

widewide match with the fixed word form. Example: “an elephant in instalments”

wide-fixed - wide match with the fixed word form. Example: “an elephant in instalments”

size

Number of results per page in response

int

yes

100

"size": {{page_size}}

min: 1, max: 1000

Response metrics:

Metrics

Description

Type

id

Query id which is used to process asynchronous queries. Matches value in a query

int

result

Contains the answer

array

task Id

Query id to get parsing results by  SerpstatTaskProcedure.getTaskResultFreq string

accepted

Total number of keywords set for parsing excluding blocked int

blocked

Array of blocked keywords. Limits aren’t charged. array

Keywords block

Some keywords will get to blocked array in the method’s response, because there’s no frequency checking for keywords containing the following search operators:

  • site:
  • related:
  • info:
  • cache:
  • OR 
  • url:
  • inurl:

Additional for Yandex

  • title:
  • rhost:
  • host:
  • domain:
  • mime:
  • lang:
  • date:
  • cat:

Keywords cleaning for special elements

Special elements are deleted from unblocked keywords. A list of prohibited special elements:

'  

*

+

-

@

~

!

&

|

(

)

:

.

;

Frequency issue block for search engine

Keywords may not pass the frequency checking for a search engine. The keywords’ subject that won’t pass checking.

for Google:

https://support.google.com/adspolicy/answer/6008942?hl=ru

for Yandex:

https://yandex.ru/support/direct/moderation/restricted-categories.html

If the keyword failed a search engine check, SerpstatTaskProcedure.getTaskResultFreq method will fill the status field for a keyword with value 4.

Limits:

This method corresponds to specific limits. You will find conditions and price details following this link.

7.2. 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

Response metrics:

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

7.3. Position check status within SVCS V4 (SerpstatTaskProcedure.getTaskStatus)

SerpstatTaskProcedure.getTaskStatus — this method helps to obtain a position's check status with “task_id by SerpstatTaskProcedure.addKeywordListFreq.

Request parameters:

Parameter

Description

Type

Optional

Default value

Value Options

task Id

Query id

string

no

-

352ab0be-b8a4-4966-8d16-f9137cb93c23

page

Ordinal number of result page

int

yes

1

50

pageSize

Number of results on a page

int

yes

100

1000

Response metrics:

Parameter

Description

Type

id

Query id used to process asynchronous queries

int

result

Object with results

json object

totalKeywords

Total number of keywords in a task flagged for position checking

int

progress

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

int

keywordsStatusCount

Array of 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

Share this article with your friends

Sign In Free Sign Up

You’ve reached your query limit.

Or email
Forgot password?
Or email
Optional
Back To Login

Don’t worry! Just fill in your email and we’ll send over your password.

Are you sure?

Awesome!

To complete your registration you need to enter your phone number

Back

We sent confirmation code to your phone number

Your phone Resend code Queries left

Something went wrong.

Contact our support team
Or confirm the registration using the Telegram bot Follow this link
Please pick the project to work on

Personal demonstration

Serpstat is all about saving time, and we want to save yours! One of our specialists will contact you and discuss options going forward.

These may include a personal demonstration, a trial period, comprehensive training articles & webinar recordings, and custom advice from a Serpstat specialist. It is our goal to make you feel comfortable while using Serpstat.

Name

Email

Phone

We are glad of your comment
Upgrade your plan

Upgrade your plan

Export is not available for your account. Please upgrade to Lite or higher to get access to the tool. Learn more

Sign Up Free

Спасибо, мы с вами свяжемся в ближайшее время

Invite
View Editing

E-mail
Message
Optional
E-mail
Message
Optional

You have run out of limits

You have reached the limit for the number of created projects. You cannot create new projects unless you increase the limits or delete existing projects.

I want more limits