Description Usage Arguments Value API rows consumption Sorting Filtering Examples
View source: R/search_analytics.R
Returns up to 60 000 organic keywords from selected region for the domain with a number of metrics for each keyword.
1 2 3 4 5 6 7 8 9 10 11 12 13 |
api_token |
(required) Serpstat API token from your profile. |
domain |
(required) Domain to get data for. |
se |
(required) Search engine alias (db_name) returned by
|
url |
(optional) Get the results for this URL only. |
keywords |
(optional) A vector of words. Keywords in response will contain these words |
minusKeywords |
(optional) A vector of words. Keywords in response will not contain these words. |
sort |
(optional) A field to sort the response. See Sorting for more details. |
filters |
(optional) A list of filtering options. See Filtering for more details. |
page |
(optional) Page number if there are many pages in response. |
size |
(optional) Page size. Optional parameters for filtering, sorting and walking through the pages of the response are described here. |
return_method |
(optional) Accepted values are 'list' (default) to return data object as list or 'df' to return data object as data.frame. |
Returns a number metrics for each keyword.
1 per keyword in response.
You can sort the response using sort
argument. It must be a list
with a single named element. The name of the element must match one of
parameters in response. The value of the element must be asc
for
ascending order and desc
for descending order. For example,
sort = list(ads = 'desc')
would sort the response by ads
parameter in descending order.
To filter the results you can use filters
argument. It must be a
list of named elements. The name of the element must match one of the
filtering parameters described
here.
You can find all the acceptable values for each parameter there too. For
example, filters = list(queries_from = 0, queries_to = 10)
would
narrow the results to include only the keywords that have a search volume
between 0 and 10.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | ## Not run:
api_token <- 'api_token'
sst_sa_domain_keywords(
api_token = api_token,
domain = 'serpstat.com',
se = 'g_us',
sort = list(keyword_length = 'desc'),
url = 'https://serpstat.com/',
keywords = list('google'),
minusKeywords = list('download'),
filters = list(queries_from = 0,
queries_to = 10),
page = 2,
size = 10,
return_method = 'df'
)$data
## End(Not run)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.