Get Groups List
/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
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
Responses
The list of all the groups, and their subgroups, if any.(200)
The list of all the groups, and their subgroups, if any.
HTTP Code: 200
Content Type : JSON
Data Schema
array of:
group_id
string
required
name
string
required
type
string
required
subgroups
array [object {1}]
required
value
string
required
ExampleThe list of all the groups, and their subgroups, if any.
[
{
"group_id": "<integer>",
"name": "<string>",
"type": "<string>",
"subgroups": [
{
"value": "<Circular reference to #/components/schemas/group detected>"
},
{
"value": "<Circular reference to #/components/schemas/group detected>"
}
]
},
{
"group_id": "<integer>",
"name": "<string>",
"type": "<string>",
"subgroups": [
{
"value": "<Circular reference to #/components/schemas/group detected>"
},
{
"value": "<Circular reference to #/components/schemas/group detected>"
}
]
}
]
Modified at a month ago