Get Groups List - SEOmonitor API 3.0

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:

Header Params

string

required

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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"
            }
        ]
    }
]