Get Ranking Keywords
This endpoint returns the keywords on which the specified domain or URL ranks in top 100.
For each keyword, it will return SERP, search and two sets of ranking data for your campaign domain, and for the requested one.
Request
(Required) This parameter specifies the ID of the campaign for which you want to return data.
Please refer to the Quick Start Guide to learn how to retrieve the IDs of your campaigns.
(Required) This parameter specifies the domain or URL path for which you want to return the keywords ranking in top 100.
If you request a domain, the endpoint will return the data for the entire domain.
If you request a URL, the endpoint will return the data only for the specified URL path.
This parameter determines the maximum number of records to return in a single request.
Maximum Value: 1000 records per request
If you do not specify a limit
, the default number of records returned per request will be 100.
This parameter specifies the starting point within the collection of resource results. It's typically used with the limit
parameter to implement pagination.
If you do not specify an offset
, the API will start from the first record.
This parameter enables you to sort the returned data based on a specified field.
The field names you can use to sort data are:
search_volume
year-over-year
rank
: Sorts the data based on the keyword rank for the requested domain or URL.
rank_trend
: Sorts the data based on the trend in keyword ranking for the requested domain or URL.
my_rank
: Sorts the data based on the keyword rank for the tracked website.
my_rank_trend
: Sorts the data based on the trend in keyword ranking for the tracked website.
percentage_clicks
: Sorts the data based on the percentage of clicks that end up on organic results after discounting the impact of the top 10 SERP features present on the keyword.
This parameter determines the sorting direction of the order_by
field. You can sort the data in either ascending (asc
) or descending (desc
) order.
If you do not specify an order_direction
, the default is asc
.
The type of keywords you want to return data for. Allowed values are overlapping
, non-overlapping
, or all-keywords
.
If the keyword_gap_type
is not specified, data for all-keywords
is returned.
The search
parameter allows you to filter the results based on a keyword name search. The API will return only those records where the keyword matches (fully or partially) the provided search term.
The search parameter is case-insensitive, allowing partial matches irrespective of casing.
Request samples
Responses
{
"keyword": "<string>",
"search_data": {
"search_volume": "<integer>",
"year_over_year": "<double>",
"monthly_searches": {
"search_volume": "<integer>",
"month": "<string>",
"year": "<integer>"
}
},
"ranking_data": {
"updated_on": "<date>",
"my_rank": {
"rank": "<integer>",
"trend": "<integer>",
"landing_page": "<string>"
},
"competitor_rank": {
"rank": "<integer>",
"trend": "<integer>",
"landing_page": "<string>"
}
},
"serp_data": {
"percentage_clicks": "<number>",
"serp_features": {
"feature": "<string>",
"position": "<integer>"
}
},
"tracked_keyword_id": "<integer>"
}