Get Topic Overview
/research/v3.0/topic-overview
This endpoint returns the overall aggregated search, SERP, and your website's Visibility data for all the related keywords of a specified keyword (topic).
Request
Query Params
campaign_id
integer
required
(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.
Example:
{{campaign_id}}
keyword
string
required
(Required) The topic for which you want to return related keywords' data.
Example:
{{keyword}}
Header Params
Accept
string
required
Example:
application/json
Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSON
Data Schema
related_keywords
string
required
search_data
object {3}
required
search_volume
string
required
year_over_year
string
required
monthly_searches
object {3}
required
serp_data
object {2}
required
percentage_clicks
string
required
serp_features
array [object {2}]
required
visibility_data
object {2}
required
visibility
string
required
trend
string
required
Example
{
"related_keywords": "<integer>",
"search_data": {
"search_volume": "<integer>",
"year_over_year": "<double>",
"monthly_searches": {
"search_volume": "<integer>",
"month": "<string>",
"year": "<integer>"
}
},
"serp_data": {
"percentage_clicks": "<integer>",
"serp_features": [
{
"feature": "<string>",
"count": "<integer>"
},
{
"feature": "<string>",
"count": "<integer>"
}
]
},
"visibility_data": {
"visibility": "<double>",
"trend": "<double>"
}
}
Modified at a month ago