Sending keywords to frequency parsing (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 |
exact - doesn’t care about word order but does care about word form. Example: “!buy in instalments!” extra - cares about both word form and order. Example: “[!buy!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: “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.