Get Related Keywords
This endpoint returns the SERP, search, and your ranking data of the related keywords for a specified keyword (topic).
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) The topic for which you want to return related keywords' data.
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:
connection_strength
search_volume
year-over-year
rank
rank_trend
percentage_clicks
If not otherwise specified, the returned data will be sorted by connection_strength
by default.
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 search
parameter allows you to filter the results based on a keyword 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>",
"connection_strength": "<integer>",
"search_data": {
"search_volume": "<integer>",
"year_over_year": "<double>",
"monthly_searches": {
"search_volume": "<integer>",
"month": "<string>",
"year": "<integer>"
}
},
"ranking_data": {
"updated_on": "<date>",
"rank": "<integer>",
"trend": "<integer>",
"landing_page": "<string>"
},
"serp_data": {
"percentage_clicks": "<number>",
"serp_features": {
"feature": "<string>",
"position": "<integer>"
}
},
"tracked_keyword_id": "<integer>"
},
{
"keyword": "<string>",
"connection_strength": "<integer>",
"search_data": {
"search_volume": "<integer>",
"year_over_year": "<double>",
"monthly_searches": {
"search_volume": "<integer>",
"month": "<string>",
"year": "<integer>"
}
},
"ranking_data": {
"updated_on": "<date>",
"rank": "<integer>",
"trend": "<integer>",
"landing_page": "<string>"
},
"serp_data": {
"percentage_clicks": "<number>",
"serp_features": {
"feature": "<string>",
"position": "<integer>"
}
},
"tracked_keyword_id": "<integer>"
}
]