Get Overview Data
GEThttps://apigw.seomonitor.com/v3/keyword-vault/v3.0/get-overview-dataThis endpoint returns the overall aggregated search, SERP, and Visibility data for all the keywords of a specified list in the Keyword Vault.
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}}
list
string
required
(Required) The name of the list created in the Keyword Vault for which you want to return keyword data.
Example:
{{list}}
Header Params
Accept
string
required
Example:
application/json
Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
keyword_count
string
required
search_data
object
required
search_volume
string
required
year_over_year
string
required
monthly_searches
object
required
serp_data
object
required
percentage_clicks
string
required
serp_features
object
required
visibility_data
object
required
visibility
string
required
trend
string
required
Example
{
"keyword_count": "<integer>",
"search_data": {
"search_volume": "<integer>",
"year_over_year": "<double>",
"monthly_searches": {
"search_volume": "<integer>",
"month": "<string>",
"year": "<integer>"
}
},
"serp_data": {
"percentage_clicks": "<number>",
"serp_features": {
"feature": "<string>",
"position": "<integer>"
}
},
"visibility_data": {
"visibility": "<double>",
"trend": "<double>"
}
}Last modified: a month ago