How You Can Help Ukrainians Today (SE Ranking Team Included)Learn here

Backlink groups API

Getting a list of backlink groups

The method allows to get a list and number of backlink groups.

Request format

GET /backlink-groups/{site_id}

Request parameters

NameRequiredDescription
site_idYesWebsite ID

Result

If successful, the server returns the list and number of backlink groups.

Response example

{
“total_groups”: 2,
“groups”: [
{
“id”: 1,
“name”: “General”,
“count”: 5
},
{
“id”: 2,
“name”: “Second group”,
“count”: 1
}
]
}

Response parameters

NameDescription
total_groupsTotal number of groups
groupsArray of groups
idGroup ID
nameGroup name
countNumber of backlinks in group

Creating a group of backlinks

The method allows to create a group of website backlinks.

Request format

POST /backlink-groups/{site_id}
{
“name”: “Group name”
}

Request parameters

NameRequiredDescription
site_idYesWebsite ID
nameYesGroup name

Result

If successful, the server returns a backlink group ID.

Response example

{
“group_id”: 2
}

Response parameters

NameDescription
group_idBacklink group ID

Deleting a backlink group

The method allows to delete a group of a website’s backlinks.

Request format

DELETE /backlink-groups/{site_id}?id={id}

Request parameters

NameRequiredDescription
site_idYesWebsite ID
idYesBacklink group ID

Result

If successful, the server returns the 204 HTTP code.

Renaming a backlink group

The method allows to change the name of a backlink group.

Request format

PUT /backlink-groups/{site_id}
{
“id”: 2,
“name”: “New group name”
}

Request parameters

NameRequiredDescription
site_idYesWebsite ID
idYesBacklink group ID
nameYesNew backlink group name

Result

If successful, the server returns the 204 HTTP code.

Moving backlinks to another group

The method allows to move backlinks from one group to another.

Request format

POST /backlink-groups/{site_id}/move
{
“id”: 1,
“backlink_ids”: [1],
“group_ids”: [2]
}

Request parameters

NameRequiredDescription
site_idYesWebsite ID
idYesBacklink group ID to move to
backlink_idsNoArray of IDs of backlinks to be moved
group_idsNoArray of IDs of backlink groups to be moved

Result

If successful, the server returns the 204 HTTP code.