SEOmonitor API 3.0
  1. Rank Tracker
SEOmonitor API 3.0
  • Overview
  • Campaigns
    • Get Tracked Campaigns
      GET
  • Rank Tracker
    • Get Keyword Data
      GET
    • Get Keyword AI Overview Data
      GET
    • Get Groups List
      GET
    • Get Keywords Competition Data
      GET
    • Get Top 100 Results
      GET
    • Get Groups Data
      GET
    • Get Daily Keyword Ranks
      GET
    • Get Daily Group Visibility
      GET
    • Add New Keywords
      POST
    • Get Keywords Import Status
      GET
    • Get Daily SERP Feature Presence
      GET
    • Get Ranking Pages
      GET
    • Get Daily Share of Clicks
      GET
  • Organic Traffic
    • Get Daily Traffic Data by Segment
      GET
    • Get Traffic Data by Keywords
      GET
  • Research
    • Keyword Research
      • By Topic
        • Get Related Keywords
        • Get Topic Overview
      • By URL/Domain
        • Get URL/Domain Overview
        • Get Ranking Keywords
      • Get Keyword Data
      • Get Ranking Data
    • Keyword Vault
      • Get Keyword Data by List
      • Get Overview Data
  • Forecast
    • Get Forecast scenarios
      GET
    • Get Forecast scenario Data
      GET
    • Get Forecast objective Data
      GET
    • Get Forecast keywords
      GET
  1. Rank Tracker

Get Groups List

GET
https://apigw.seomonitor.com/v3/rank-tracker/v3.0/groups
This endpoint allows you to retrieve all keyword groups including their structure within folders, for a particular campaign ID. It provides the hierarchical data in a nested JSON structure, with the top-level groups (folders) for the campaign ID at the root level, and any groups nested under them.
The response contains details on each group, including its unique ID, name, and type (folder, group, or smart group).

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Query Params
campaign_id
integer 
required
(Required) The campaign ID for which the group structure will be returned.
Please refer to the Quick Start Guide to learn how to retrieve the IDs of your campaigns.
Example:
{{campaign_id}}
Header Params
Accept
string 
required
Example:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://apigw.seomonitor.com/v3/rank-tracker/v3.0/groups?campaign_id={{campaign_id}}' \
--header 'Accept: application/json' \
--header 'Authorization;'

Responses

🟢200The list of all the groups, and their subgroups, if any.
application/json
Body
array of:
group_id
integer 
optional
The unique identifier for the keyword group. It can be used to reference the group in other endpoints.
name
string 
optional
The name of the group.
type
string 
optional
Indicates the type of group - either a regular group, a folder for organizing groups, or smart group based on rules. Possible values are group, folder, or smart_group.
subgroups
array [object {3}] 
optional
group_id
integer 
optional
The unique identifier for the keyword group. It can be used to reference the group in other endpoints.
name
string 
optional
The name of the group.
type
string 
optional
Indicates the type of group - either a regular group, a folder for organizing groups, or smart group based on rules. Possible values are group, folder, or smart_group.
Example
[
  {
    "group_id": 12345,
    "name": "Keyword Opportunities",
    "type": "folder",
    "subgroups": [
      {
        "group_id": 178456,
        "name": "High opportunity",
        "type": "smart_group"
      },
      {
        "group_id": 184567,
        "name": "High search volume",
        "type": "smart_group"
      }
    ]
  }
]
Modified at 2024-11-05 13:56:57
Previous
Get Keyword AI Overview Data
Next
Get Keywords Competition Data
Built with