Get Ranking Pages
This endpoint returns the ranking pages of the tracked keywords in a campaign.
The response contains an array with ranking pages and their URL, title, description, and associated keyword IDs.
Note: Using the keyword IDs of the ranking keywords for the returned landing pages, you can make API calls through the other endpoints, in order to further process landing page-level search volumes, Visibility, and other metrics.
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.
The IDs of specific groups in the campaign to get keyword data for.
Please refer to the Quick Start Guide to learn how to retrieve the IDs of your groups.
If you do not specify a group_id
, the default value is the All Keywords
group, which means data will be returned for all active keywords in the campaign.
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.
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 default is 0
, which means the API will start from the first record.
The search
parameter allows you to filter for landing pages that include the searched term or URL path.
The API will return only those records where the landing page matches (fully or partially) the provided search term or URL.
Request samples
Responses
[
{
"url": "<string>",
"title": "<string>",
"description": "<string>",
"ranking_keywords": {
"keyword_id": "<integer>",
"keyword": "<string>"
}
},
{
"url": "<string>",
"title": "<string>",
"description": "<string>",
"ranking_keywords": {
"keyword_id": "<integer>",
"keyword": "<string>"
}
}
]