Get Groups Data
With this endpoint, you can retrieve overall aggregated search and SERP data along with Visibility metrics and trends for all the keywords of the groups specified through group IDs.
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 start date of the timeframe for which you want to return the data in YYYY-MM-DD format.
(Required) The end date of the timeframe for which you want to return the data in YYYY-MM-DD format.
The ID(s) of the group(s) for which you want to return data.
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 All Keywords
group, which means data will be returned for all keywords in the campaign.
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.
Request samples
Responses
[
{
"group_id": "<integer>",
"group_name": "<string>",
"keyword_counters": {
"main_keywords": "<integer>",
"close_variations": "<integer>"
},
"serp_data": {
"desktop": {
"feature": "<string>",
"presence_count": "<integer>",
"listed_count": "<integer>"
},
"mobile": {
"feature": "<string>",
"presence_count": "<integer>",
"listed_count": "<integer>"
}
},
"percentage_clicks": "<double>",
"search_intent": {
"informational": "<double>",
"commercial": "<double>",
"transactional": "<double>"
},
"search_data": {
"search_volume": "<integer>",
"monthly_searches": [
{
"search_volume": "<integer>",
"month": "<string>",
"year": "<integer>"
},
{
"search_volume": "<integer>",
"month": "<string>",
"year": "<integer>"
}
],
"volume_by_device": {
"desktop": "<double>",
"mobile": "<double>"
},
"year_over_year": "<double>"
},
"visibility": {
"desktop": {
"latest": "<double>",
"trend": "<double>"
},
"mobile": {
"latest": "<double>",
"trend": "<double>"
}
},
"opportunity": {
"score": "<number>",
"additional_monthly_sessions": "<integer>",
"difficulty": "<string>",
"avg_cpc": "<double>"
},
"traffic_data": {
"sessions": "<integer>",
"ecommerce": {
"transactions": "<integer>",
"revenue": "<integer>"
},
"goals": {
"revenue": "<integer>",
"completions": "<integer>"
}
}
},
{
"group_id": "<integer>",
"group_name": "<string>",
"keyword_counters": {
"main_keywords": "<integer>",
"close_variations": "<integer>"
},
"serp_data": {
"desktop": {
"feature": "<string>",
"presence_count": "<integer>",
"listed_count": "<integer>"
},
"mobile": {
"feature": "<string>",
"presence_count": "<integer>",
"listed_count": "<integer>"
}
},
"percentage_clicks": "<double>",
"search_intent": {
"informational": "<double>",
"commercial": "<double>",
"transactional": "<double>"
},
"search_data": {
"search_volume": "<integer>",
"monthly_searches": [
{
"search_volume": "<integer>",
"month": "<string>",
"year": "<integer>"
},
{
"search_volume": "<integer>",
"month": "<string>",
"year": "<integer>"
}
],
"volume_by_device": {
"desktop": "<double>",
"mobile": "<double>"
},
"year_over_year": "<double>"
},
"visibility": {
"desktop": {
"latest": "<double>",
"trend": "<double>"
},
"mobile": {
"latest": "<double>",
"trend": "<double>"
}
},
"opportunity": {
"score": "<number>",
"additional_monthly_sessions": "<integer>",
"difficulty": "<string>",
"avg_cpc": "<double>"
},
"traffic_data": {
"sessions": "<integer>",
"ecommerce": {
"transactions": "<integer>",
"revenue": "<integer>"
},
"goals": {
"revenue": "<integer>",
"completions": "<integer>"
}
}
}
]