Get Groups Data
GEThttps://apigw.seomonitor.com/v3/rank-tracker/v3.0/groups/dataWith 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
The unique identifier for the group in the SEOmonitor system.
The name assigned to the group in the SEOmonitor platform.
Parent field containing counts of the total number of main keywords and close variations in the group.
The total number of main keywords (non-close variations) present in the group.
The total number of close variations present in the group.
Parent field containing the top 10 SERP features present for the keywords in the specified group and their presence count for the last day of the selected timeframe, segmented by device. Please refer to the Quick Start Guide for the complete feature name of each abbreviation.
Parent field containing the top 10 SERP features data for desktop devices.
Parent field containing the top 10 SERP features data for mobile devices.
The percentage of searches that end up clicking on organic results, after discounting the searches satisfied by SERP features. Blended metric between desktop and mobile searches.
Parent field containing the search intent breakdown of the group in percentages out of its total search volume
The percentage of the search volume of keywords that have informational search intent.
The percentage of the search volume of keywords that have commercial search intent.
The percentage of the search volume of keywords that have transactional search intent.
Parent field containing the aggregated data related to Google search volumes for the keywords in the specified group.
The average 12-month search volume of all the keywords included in the group, as provided by Google Ads.
An array of objects containing the aggregated search volumes for each of the previous 13 months as provided by Google Ads.
Parent field of the percentage share of the total searches of all keywords in the group, segmented by device.
A numeric value representing the last month's search volume divided by the search volume of the same month of the previous year. E.g. +49% year-over-year search trend would be represented as 1.49. The returned values will be capped at 10, which represents "newcomers" (keywords that registered very low search volumes in the previous year).
Parent field containing the overall Visibility of the website for all the keywords present in the group segmented by device and the Visibility trend.
Parent field containing the desktop Visibility of the website for all the keywords of the group and the change in its percentage.
Parent field containing the mobile Visibility of the website for all the keywords of the group and the change in their percentage.
Parent field containing the SEO opportunity score and related data for the keywords the page is ranking for. The group SEO opportunity score is an averaged custom metric designed to aggregate multiple keyword attributes into a single score representing the potential value and ease of ranking in top 3 for that keyword.
The Opportunity score from 0 to 10. For the keywords where the Opportunity score is not computed, the value returned will be "N/A".
The potential additional monthly sessions if the keywords rank in top 3 on average.
The average cost per click.
The Difficulty level of the keyword to rank in Top 10. Possible values are "already_top_10", "easy", "medium", or "hard".
Parent field containing the traffic data associated with the keywords in the specified group, and traffic trends recorded in the given timeframe.
The sum of sessions, if the campaign is connected to both Google Search Console and Google Analytics – or clicks, if the campaign is only connected to Google Search Console, within the selected timeframe.
Parent field containing ecommerce transaction data including the number of transactions and the revenue generated by the keywords.
Parent field containing goals transaction data including the number of completions and the revenue generated by the keywords.
[
{
"group_id": 2261,
"group_name": "Bath Department",
"keyword_counters": {
"main_keywords": 123,
"close_cariations": 3
},
"serp_data": {
"desktop": [
{
"feature": "AIO",
"presence_count": 11,
"listed_count": 1
},
{
"feature": "AIB",
"presence_count": 10,
"listed_count": 9
},
{
"feature": "IMG",
"presence_count": 100,
"listed_count": 10
}
],
"mobile": [
{
"feature": "AIO",
"presence_count": 11,
"listed_count": 1
},
{
"feature": "AIB",
"presence_count": 10,
"listed_count": 9
},
{
"feature": "IMG",
"presence_count": 100,
"listed_count": 10
}
]
},
"percentage_clicks": 0.69,
"search_intent": {
"informational": 0.25,
"commercial": 0.2,
"transactioal": 0.55
},
"search_data": {
"search_volume": 5903860,
"monthly_searches": [
{
"month": "January",
"year": "2023",
"search_volume": 8293610
}
],
"volume_by_device": {
"desktop": 0.24605408651822203,
"mobile": 0.753945913481778
},
"year_over_year": 1.5
},
"visibility": {
"desktop": {
"latest": 11.8,
"trend": -0.44
},
"mobile": {
"latest": 11.8,
"trend": -0.24
}
},
"opportunity": {
"score": 8,
"difficulty_top_10": "hard",
"additional_monthly_sessions": 18744,
"avg_cpc": 0.06
},
"traffic_data": {
"sessions": 0,
"ecommerce": {
"transactions": 0,
"revenue": 0
},
"goals": {
"completions": 0,
"revenue": 0
}
}
}
]