sst_sa_domain_organic_competitors {serpstatr} | R Documentation |
Domain competitors in organic search
Description
Returns organic competitors for the domain with their key metrics.
Usage
sst_sa_domain_organic_competitors(
api_token,
domain,
se,
sort = NULL,
page = 1,
size = 100,
return_method = "list"
)
Arguments
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
|
sort |
(optional) A field to sort the response. See Sorting for more details. |
page |
(optional) Response page number if there are many pages in response. |
size |
(optional) Response page size. |
return_method |
(optional) Accepted values are 'list' (default) to return data object as list or 'df' to return data object as data.frame. |
Value
Returns a number of metrics for each organic competitor.
API docs
Check all the values for request and response fields here.
API credits consumption
1 per returned page.
Sorting
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.
Filtering
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. See API docs for more details. 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.
Examples
## Not run:
api_token <- Sys.getenv('SERPSTAT_API_TOKEN')
sst_sa_domain_organic_competitors(
api_token = api_token,
domain = 'serpstat.com',
se = 'g_us',
sort = list(relevance = 'desc'),
page = 2,
size = 20,
return_method = 'df'
)$data
## End(Not run)